{"items":[{"type":"link","label":"Finix API Reference","link":"/api","routeSlug":"/api","content":{"contentType":"overview","meta":{"name":"Finix API Reference"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://finix.com","url":"https://finix.com"},{"kind":"email","title":"Finix","email":"support@finix.com","label":"support@finix.com","withCopyButton":true,"copyContent":"support@finix.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"cURL","lang":"curl"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Finix API Reference","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":"The Finix API is resource oriented, relying heavily on common REST principles. Our API uses JSON encoded requests and responses."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You will receive separate Sandbox and Live accounts, as well as corresponding API credentials to access the Finix API."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api"}],"sectionId":"/api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To communicate with the Finix API, you must authenticate your requests via HTTP Basic Authentication with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username:password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" combination, which you can get from your Finix Dashboard. If you do not have a Dashboard yet, you can test our APIs with the Sandbox credentials below."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"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":"Parameter"},"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":"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":"Sandbox Username"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USsRhsHYZGBPnQw8CByJyEQW"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox Password"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8a14c2f9-d94b-4c72-8f5c-a62908e5b30e"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl \"https://finix.sandbox-payments-api.com/\" \\\n    -H \"Content-Type: application/json\" \\\n    -H \"Finix-Version: 2022-02-01\" \\\n    -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n","language":"shell","title":"Request Format"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl \"https://finix.sandbox-payments-api.com/\" \\\n    -H \"Content-Type: application/json\" \\\n    -H \"Finix-Version: 2022-02-01\" \\\n    -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"},"children":[]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/environments"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Environments"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix provides two environments with distinct base URLs to make API requests."},"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":"A Sandbox environment for developing and testing your integration."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Live environment for processing payments."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These environments are entirely separate and do not share API Credentials."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"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":"Environment"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Endpoint URL"},"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":"Sandbox"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://finix.sandbox-payments-api.com"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Live"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://finix.live-payments-api.com"},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info","name":"Live Access"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To get access to the Live environment, please reach out to your Finix point-of-contact."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/section/environments"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/http-codes-and-errors"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Codes and Errors"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix uses HTTP codes to communicate whether requests succeeded or failed. Requests to Finix's API return responses within less than one second."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"However, communications between card networks and processors can increase response latency. Response latency for card-present devices can also be higher depending on how quickly buyers complete the transaction on payment terminals."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Due of this, requests to the Finix API have a maximum timeout of 5 minutes."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/implementation-and-testing/error-codes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Also, you can "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/implementation-and-testing/testing-your-integration/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"test for specific errors and responses"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{"width":"10%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"width":"35%"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Definition "},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{"width":"55%"},"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":"code","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":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We could not parse your request. Verify you are providing valid JSON."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","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":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We could not authenticate your request. Verify your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are correct."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"402"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upstream Processor Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Errors caused by 3rd-party service(s)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"403"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forbidden"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your credentials do not have the correct permissions to perform the request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","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":"Not Found"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We could not find the specified resource."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"405"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Method Not Allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The specified resource does not support the HTTP Method used to submit the request."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"406"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not Acceptable"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The server could accept the submitted request. Confirm how the request was formatted and submitted."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conflict"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The submitted request conflicts with the current state of the server."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parameters were valid, but the request failed. Usually, the error involves misunderstanding of how to perform the request (e.g., creating a transfer with a seller that is not-yet-approved)."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"500"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Internal Server Error"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We had a problem with our server. Try again later."},"children":[]}]}]}]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/section/http-codes-and-errors"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/idempotent-requests"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idempotent Requests"},"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":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources both have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. Use this field to ensure the API Request is performed "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only once"},"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":"Why is this important? We've all experienced a checkout page that hangs on a request or payment, and feared that if we refresh or submit the payment again, we'd be charged twice."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix removes this ambiguity with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You or the user can generate a unique ID that can be included as an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the usual request payload. If anyone attempts a request with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response will raise an exception."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By passing an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body of your requests, you can be rest assured that when you create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the user will be protected from potential network issues."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is available on the following three 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":"code","inline":true,"attributes":{"content":"/transfers"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/authorizations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/transfers/{id}/reversals"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"`idempotency_id` scope"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" checks against previous requests made on the same endpoint."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/section/idempotent-requests"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every Finix resource (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") can be listed and reviewed using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests. Every endpoint also has query parameters available to help you filter the resources that are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the following example of how to query the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl \"https://finix.sandbox-payments-api.com/transfers?type=DEBIT\" \\\n    -H \"Finix-Version: 2022-02-01\" \\\n    -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n","language":"shell","title":"Query Parameter Example"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl \"https://finix.sandbox-payments-api.com/transfers?type=DEBIT\" \\\n    -H \"Finix-Version: 2022-02-01\" \\\n    -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n"},"children":[]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/section/query-parameters"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/tags"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Many Finix resources (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") let you include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to add key-value metadata to your Finix API resources. For example, when creating a Transfer, you might include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customerId: Customer123"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to tag the Transfer with your internal customer ID. You can update tags as many times as needed, as well as filter resources by tags."},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n    ...,\n    \"tags\": {\n        \"card-type\": \"business card\",\n        \"order_number\": \"H-1257\",\n        \"customer_order_reference\": \"order1234\",\n        \"item_type\": \"hardware\",\n        \"vendor\": \"finix\"\n    }\n}\n","language":"json","title":"Tags Example"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n    ...,\n    \"tags\": {\n        \"card-type\": \"business card\",\n        \"order_number\": \"H-1257\",\n        \"customer_order_reference\": \"order1234\",\n        \"item_type\": \"hardware\",\n        \"vendor\": \"finix\"\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":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object accepts up to 50 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pairs to annotate resources with custom metadata."},"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":"Maximum character length for individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 40."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum character length for individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 500."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Special Characters"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix does "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" allow special characters on tags (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"'"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/section/tags"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/versioning"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"As Finix improves our products and features, we will make changes to our APIs. When breaking changes are made to Finix's API, we may release a new dated API version."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The API version your requests use controls how API responses and webhooks behave (for example, the values you see in responses and the parameters you can include in requests). For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/authentication-and-api-basics/versioning/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]}]}],"sectionId":"/api/section/versioning"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/postman-collection"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Postman Collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix has a Postman collection to help in your development. You can fork it using the button below."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://god.gw.postman.com/run-collection/47694266-26c1778a-64ad-473d-ba6f-440777f2c9c8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D47694266-26c1778a-64ad-473d-ba6f-440777f2c9c8%26entityType%3Dcollection%26workspaceId%3D72d1f1c9-5637-4a7f-be9b-25fc89a3a2ff"},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"img","attrs":{"id":"postman-btn","src":"https://run.pstmn.io/button.svg","alt":"Run In Postman","style":{"width":"128px","height":"32px"}}},"children":[]}]}]}]}]}],"sectionId":"/api/section/postman-collection"}]}]}},{"type":"link","label":"Authentication","link":"/api/section/authentication","routeSlug":"/api/section/authentication","content":null},{"type":"link","label":"Environments","link":"/api/section/environments","routeSlug":"/api/section/environments","content":null},{"type":"link","label":"HTTP Codes and Errors","link":"/api/section/http-codes-and-errors","routeSlug":"/api/section/http-codes-and-errors","content":null},{"type":"link","label":"Idempotent Requests","link":"/api/section/idempotent-requests","routeSlug":"/api/section/idempotent-requests","content":null},{"type":"link","label":"Query Parameters","link":"/api/section/query-parameters","routeSlug":"/api/section/query-parameters","content":null},{"type":"link","label":"Tags","link":"/api/section/tags","routeSlug":"/api/section/tags","content":null},{"type":"link","label":"Versioning","link":"/api/section/versioning","routeSlug":"/api/section/versioning","content":null},{"type":"link","label":"Postman Collection","link":"/api/section/postman-collection","routeSlug":"/api/section/postman-collection","content":null},{"type":"separator","label":"Main Resources","content":null},{"type":"group","label":"3D Secure Sessions","link":"/api/3d-secure-sessions","routeSlug":"/api/3d-secure-sessions","items":[{"label":"Create a 3D Secure Session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/3d-secure-sessions/create3dsecuresession","routeSlug":"/api/3d-secure-sessions/create3dsecuresession","metadata":{"seo":{"title":"Create a 3D Secure Session","description":"Create a 3D Secure Session to authenticate a buyer before you charge their card."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create3DSecureSession","name":"Create a 3D Secure Session","isWebhook":false,"pointer":"/paths/~13d_secure_sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a 3D Secure 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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to authenticate a buyer before you charge their card."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create the session from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_instrument_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the redirect flow or standalone "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Finix.ThreeDSecure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ThreeDSecure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment form option. For redirect flows, pass the session ID after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reaches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". With Finix.js, pass it when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" callback fires, even if the session resource still reads "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~13d_secure_sessions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Token"]}},"schemaId":"schema_2","exampleIds":["paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Token"],"pointer":"/paths/~13d_secure_sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/3d_secure_sessions","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Token"]}},"responseCodes":["201","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/3d_secure_sessions","href":"3d-secure-sessions/create3dsecuresession","openApiOperationId":"create3DSecureSession","summary":"Create a 3D Secure Session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_2","exampleIds":["paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Token"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Token"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3d_secure_session","exampleIds":["paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Token"]}},"schemaId":"components/schemas/3d_secure_session","exampleIds":["paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Token"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~13d_secure_sessions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/3d_secure_session","exampleIds":["paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Token"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3d_secure_session","exampleIds":["paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - USA","paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada","paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Token"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3d-secure-sessions/create3dsecuresession"}],"panels":[]}]},"httpPath":"/3d_secure_sessions"},{"label":"Fetch a 3D Secure Session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/3d-secure-sessions/get3dsecuresession","routeSlug":"/api/3d-secure-sessions/get3dsecuresession","metadata":{"seo":{"title":"Fetch a 3D Secure Session","description":"Retrieve the details of a 3D Secure Session to check the state of the authentication and read the values the card network returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"get3DSecureSession","name":"Fetch a 3D Secure Session","isWebhook":false,"pointer":"/paths/~13d_secure_sessions~1{3d_secure_session_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a 3D Secure 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":"text","inline":true,"attributes":{"content":"Retrieve the details of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to check the state of the authentication and read the values the card network returned."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"3d_secure_session_id","in":"path","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~13d_secure_sessions~1{3d_secure_session_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~13d_secure_sessions~1{3d_secure_session_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/3d_secure_sessions/{3d_secure_session_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"3d_secure_session_id","in":"path","required":true,"example":"3d_secure_session_wUCqan1LqeEHbYSwozMcFT","schemaId":"schema_4"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/3d_secure_sessions/{3d_secure_session_id}","href":"3d-secure-sessions/get3dsecuresession","openApiOperationId":"get3DSecureSession","summary":"Fetch a 3D Secure Session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3d_secure_session","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/200/content/application~1json/examples/3D Secure Session"]}},"schemaId":"components/schemas/3d_secure_session","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/200/content/application~1json/examples/3D Secure Session"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/3d_secure_session","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/200/content/application~1json/examples/3D Secure Session"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/3d_secure_session","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/200/content/application~1json/examples/3D Secure Session"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/3d-secure-sessions/get3dsecuresession"}],"panels":[]}]},"httpPath":"/3d_secure_sessions/{3d_secure_session_id}"}],"content":{"contentType":"group","meta":{"name":"3D Secure Sessions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"3D Secure Sessions","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents one 3D Secure authentication that Finix runs on a card. Create the session, send the buyer through authentication, then reference the completed session when you create the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/authorizations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a session describes the authentication process, not its outcome. A session where the buyer was never authenticated still ends in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To find out whether the buyer was authenticated, and where chargeback liability sits, read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_authentication.electronic_commerce_indicator"},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/online-payments/fraud-and-risk/3d-secure"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3D Secure"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/3d_secure_sessions","summary":"Create a 3D Secure Session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/3d-secure-sessions/create3dsecuresession","deprecated":false},{"title":"/3d_secure_sessions/{3d_secure_session_id}","summary":"Fetch a 3D Secure Session","prefix":{"name":"get","color":"get"},"badges":[],"link":"/3d-secure-sessions/get3dsecuresession","deprecated":false}]}]}]}]}},{"type":"group","label":"Authorizations","link":"/api/authorizations","routeSlug":"/api/authorizations","items":[{"label":"Create an Authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/createauthorization","routeSlug":"/api/authorizations/createauthorization","metadata":{"seo":{"title":"Create an Authorization","description":"Create an Authorization to process a transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAuthorization","name":"Create an Authorization","isWebhook":false,"pointer":"/paths/~1authorizations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Authorization","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":"text","inline":true,"attributes":{"content":"Create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process a transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related Guides: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/auth-and-captures/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating and Capturing an Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/level-2-level-3-processing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 2 and 3 Processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/in-person-payments/building-your-integration/pos-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POS Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1authorizations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Recurring or Unscheduled"]}},"schemaId":"schema_5","exampleIds":["paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Recurring or Unscheduled"],"pointer":"/paths/~1authorizations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/authorizations","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Recurring or Unscheduled"]}},"responseCodes":["201","400","401","402","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/authorizations","href":"authorizations/createauthorization","openApiOperationId":"createAuthorization","summary":"Create an Authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_5","exampleIds":["paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Recurring or Unscheduled"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Recurring or Unscheduled"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response schema to a request to create a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Recurring or Unscheduled"]}},"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Recurring or Unscheduled"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"402","description":"Payment Required.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError"}},"schemaId":"components/schemas/genericError"},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/422/content/application~1json/examples/item_data tax values incorrect","paths/~1authorizations/post/responses/422/content/application~1json/examples/Unit of measure too long","paths/~1authorizations/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together","paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument","paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session already used"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/422/content/application~1json/examples/item_data tax values incorrect","paths/~1authorizations/post/responses/422/content/application~1json/examples/Unit of measure too long","paths/~1authorizations/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together","paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument","paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session already used"]}],"pointer":"/paths/~1authorizations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Recurring or Unscheduled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Minimal Fields","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - All Fields","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Canada","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure Session","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Authorization with CVV","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Verify CVV and AVS","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Buyer Charges","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Card Present","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Motor Vehicle Rental","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Lodging","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Gaming","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 2 Processing","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 3 Processing","paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Recurring or Unscheduled"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"402","schemaId":"components/schemas/genericError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError"}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/422/content/application~1json/examples/item_data tax values incorrect","paths/~1authorizations/post/responses/422/content/application~1json/examples/Unit of measure too long","paths/~1authorizations/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together","paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument","paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session already used"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/post/responses/422/content/application~1json/examples/item_data tax values incorrect","paths/~1authorizations/post/responses/422/content/application~1json/examples/Unit of measure too long","paths/~1authorizations/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together","paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument","paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session already used"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorizations/createauthorization"}],"panels":[]}]},"httpPath":"/authorizations"},{"label":"List Authorizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/listauthorizations","routeSlug":"/api/authorizations/listauthorizations","metadata":{"seo":{"title":"List Authorizations","description":"Retrieve a list of Authorizations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAuthorizations","name":"List Authorizations","isWebhook":false,"pointer":"/paths/~1authorizations/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Authorizations","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorizations"},"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":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no query parameters are specified in the request the API automatically limits the response to records from the last 30 days. You can request older data by passing an explicit created_at.lte filter."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"amount.gt","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than."},{"name":"amount.gte","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than or equal."},{"name":"amount.lt","in":"query","schemaId":"schema_7","description":"Filter by an amount less than."},{"name":"amount.lte","in":"query","schemaId":"schema_7","description":"Filter by an amount less than or equal."},{"name":"amount","in":"query","schemaId":"schema_7","description":"Filter by an amount equal to the given value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"currency","in":"query","schemaId":"schema_10","description":"Filter by the currency of the resource."},{"name":"device","in":"query","schemaId":"schema_11","description":"Filter by the device's ID."},{"name":"idempotency_id","in":"query","schemaId":"schema_12","description":"Filter by Idempotency ID."},{"name":"instrument_account_last4","in":"query","schemaId":"schema_13","description":"Filter Transactions by the last 4 digits of the bank account. The bank account last 4 are the last 4 digits of the masked account number."},{"name":"instrument_bin","in":"query","schemaId":"schema_14","description":"Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number."},{"name":"instrument_brand_type","in":"query","schemaId":"schema_15","description":"Filter by card brand."},{"name":"instrument_card_last4","in":"query","schemaId":"schema_16","description":"Filter by the payment card last 4 digits."},{"name":"instrument_name","in":"query","schemaId":"schema_17","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Transactions by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"is_void","in":"query","schemaId":"schema_18","description":"Show only voided authorizations."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant","in":"query","schemaId":"schema_20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"merchant_identity_name","in":"query","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter Transactions by name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"merchant_mid","in":"query","schemaId":"schema_22","description":"Filter by Merchant Identification Number (MID)."},{"name":"merchant_processor_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Processor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_23","description":"Filter by transaction state."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"trace_id","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trace_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1authorizations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1authorizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authorizations","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"amount.gt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"currency","in":"query","required":false,"example":"USD","schemaId":"schema_10"},{"name":"device","in":"query","example":"DVsEanpBtsAVvCHbNXkFaH6f","schemaId":"schema_11"},{"name":"idempotency_id","in":"query","example":"15d32948-c766-4033-8d87-dfbdcabcbc5c","schemaId":"schema_12"},{"name":"instrument_account_last4","in":"query","example":9444,"schemaId":"schema_13"},{"name":"instrument_bin","in":"query","example":411111,"schemaId":"schema_14"},{"name":"instrument_brand_type","in":"query","example":"VISA","schemaId":"schema_15"},{"name":"instrument_card_last4","in":"query","example":1111,"schemaId":"schema_16"},{"name":"instrument_name","in":"query","example":"Alice","schemaId":"schema_17"},{"name":"is_void","in":"query","schemaId":"schema_18"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant","in":"query","example":"MUeDVrf2ahuKc9Eg5TeZugvs","schemaId":"schema_20"},{"name":"merchant_identity_name","in":"query","example":"John","schemaId":"schema_21"},{"name":"merchant_mid","in":"query","example":"FNXrzKj8xCLBwB8FdxjfU9txe","schemaId":"schema_22"},{"name":"merchant_processor_id","in":"query","schemaId":"schema_6"},{"name":"state","in":"query","example":"SUCCEEDED","schemaId":"schema_23"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"trace_id","in":"query","required":false,"example":"021fc4ed-f0a8-4932-820c-b22b542526f8","schemaId":"schema_26"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/authorizations","href":"authorizations/listauthorizations","openApiOperationId":"listAuthorizations","summary":"List Authorizations"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/authorizations\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Authorization objects","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27","exampleIds":["paths/~1authorizations/get/responses/200/content/application~1json/examples/List of Authorizations"]}},"schemaId":"schema_27","exampleIds":["paths/~1authorizations/get/responses/200/content/application~1json/examples/List of Authorizations"],"headers":{"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"date":{"$ref":"#/components/headers/date"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1authorizations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_27","exampleIds":["paths/~1authorizations/get/responses/200/content/application~1json/examples/List of Authorizations"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27","exampleIds":["paths/~1authorizations/get/responses/200/content/application~1json/examples/List of Authorizations"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorizations/listauthorizations"}],"panels":[]}]},"httpPath":"/authorizations"},{"label":"Fetch an Authorization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/getauthorization","routeSlug":"/api/authorizations/getauthorization","metadata":{"seo":{"title":"Fetch an Authorization","description":"Retrieve the details of a previously created Authorization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAuthorization","name":"Fetch an Authorization","isWebhook":false,"pointer":"/paths/~1authorizations~1{authorization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch an Authorization","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":"text","inline":true,"attributes":{"content":"Retrieve the details of a previously created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authorization_id","in":"path","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch."},"children":[]}]}]}],"required":true,"example":"AUgUHQYgKgR2jR2J2x3nav9Z"}],"pointer":"/paths/~1authorizations~1{authorization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/authorizations/{authorization_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"authorization_id","in":"path","required":true,"example":"AUgUHQYgKgR2jR2J2x3nav9Z","schemaId":"schema_28"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/authorizations/{authorization_id}","href":"authorizations/getauthorization","openApiOperationId":"getAuthorization","summary":"Fetch an Authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"Response schema to a request to fetch a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/200/content/application~1json/examples/Authorization"]}},"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/200/content/application~1json/examples/Authorization"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1authorizations~1{authorization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/200/content/application~1json/examples/Authorization"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/200/content/application~1json/examples/Authorization"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorizations/getauthorization"}],"panels":[]}]},"httpPath":"/authorizations/{authorization_id}"},{"label":"Capture an Authorization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/captureauthorization","routeSlug":"/api/authorizations/captureauthorization","metadata":{"seo":{"title":"Capture an Authorization","description":"Use a PUT request to capture an Authorization. If captured successfully, the transfer field of the Authorization will contain the ID of the Transfer resource that moves funds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"captureAuthorization","name":"Capture an Authorization","isWebhook":false,"pointer":"/paths/~1authorizations~1{authorization_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capture an Authorization","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":"text","inline":true,"attributes":{"content":"Use a PUT request to capture an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If captured successfully, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will contain the ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that moves funds."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related Guides: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/auth-and-captures/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating and Capturing an Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/level-2-level-3-processing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 2 and 3 Processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/in-person-payments/building-your-integration/pos-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POS Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authorization_id","in":"path","schemaId":"schema_28","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch."},"children":[]}]}]}],"required":true,"example":"AUgUHQYgKgR2jR2J2x3nav9Z"}],"pointer":"/paths/~1authorizations~1{authorization_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1authorizations~1{authorization_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization with Split Transfers"]}},"schemaId":"schema_29","exampleIds":["paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization with Split Transfers"],"pointer":"/paths/~1authorizations~1{authorization_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/authorizations/{authorization_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"authorization_id","in":"path","required":true,"example":"AUgUHQYgKgR2jR2J2x3nav9Z","schemaId":"schema_28"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization with Split Transfers"]}},"responseCodes":["200","400","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/authorizations/{authorization_id}","href":"authorizations/captureauthorization","openApiOperationId":"captureAuthorization","summary":"Capture an Authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_29","exampleIds":["paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization with Split Transfers"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_29","exampleIds":["paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization with Split Transfers"]}},"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":"Response schema to a request to capture an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization with Split Transfers"]}},"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization with Split Transfers"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Incorrect sum of split_transfer amounts","paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Amount cannot be greater than the original authorization","paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Fee more than captured amount"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Incorrect sum of split_transfer amounts","paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Amount cannot be greater than the original authorization","paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Fee more than captured amount"]}],"pointer":"/paths/~1authorizations~1{authorization_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization with Split Transfers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization","paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Card Present Authorization","paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization with Split Transfers"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Incorrect sum of split_transfer amounts","paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Amount cannot be greater than the original authorization","paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Fee more than captured amount"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Incorrect sum of split_transfer amounts","paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Amount cannot be greater than the original authorization","paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Fee more than captured amount"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorizations/captureauthorization"}],"panels":[]}]},"httpPath":"/authorizations/{authorization_id}"},{"label":"Void an Authorization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/authorizations/voidauthorization","routeSlug":"/api/authorizations/voidauthorization","metadata":{"seo":{"title":"Void an Authorization","description":"Use a PUT request to void an Authorization. If voided successfully, funds get released, and the transaction is incomplete. Additionally, a voided Authorization can no longer be captured. Depending on the cardholder’s issuing bank, voids can take up to seven days to remove the Authorization hold."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidAuthorization","name":"Void an Authorization","isWebhook":false,"pointer":"/paths/~1authorizations~1{authorization_id_void_to}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Void an Authorization","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":"text","inline":true,"attributes":{"content":"Use a PUT request to void an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If voided successfully, funds get released, and the transaction is incomplete. Additionally, a voided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can no longer be captured. Depending on the cardholder’s issuing bank, voids can take up to seven days to remove the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" hold."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related Guides: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/auth-and-captures/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating and Capturing an Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/level-2-level-3-processing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 2 and 3 Processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/in-person-payments/building-your-integration/pos-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POS Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"authorization_id_void_to","in":"path","schemaId":"schema_6","required":true,"example":"AUnubzehgQfqcvJpoxhqja7k"}],"pointer":"/paths/~1authorizations~1{authorization_id_void_to}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1authorizations~1{authorization_id_void_to}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/voidAuthorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/requestBody/content/application~1json/examples/Void an Authorization"]}},"schemaId":"components/schemas/voidAuthorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/requestBody/content/application~1json/examples/Void an Authorization"],"pointer":"/paths/~1authorizations~1{authorization_id_void_to}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/authorizations/{authorization_id_void_to}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"authorization_id_void_to","in":"path","required":true,"example":"AUnubzehgQfqcvJpoxhqja7k","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"},{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/voidAuthorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/requestBody/content/application~1json/examples/Void an Authorization"]}},"responseCodes":["200","400","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/authorizations/{authorization_id_void_to}","href":"authorizations/voidauthorization","openApiOperationId":"voidAuthorization","summary":"Void an Authorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/voidAuthorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/requestBody/content/application~1json/examples/Void an Authorization"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/voidAuthorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/requestBody/content/application~1json/examples/Void an Authorization"]}},"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":"Response schema to a request to void a single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/200/content/application~1json/examples/Authorization"]}},"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/200/content/application~1json/examples/Authorization"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/422/content/application~1json/examples/Authorization already captured"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/422/content/application~1json/examples/Authorization already captured"]}],"pointer":"/paths/~1authorizations~1{authorization_id_void_to}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/200/content/application~1json/examples/Authorization"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/authorization","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/200/content/application~1json/examples/Authorization"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/422/content/application~1json/examples/Authorization already captured"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1authorizations~1{authorization_id_void_to}/put/responses/422/content/application~1json/examples/Authorization already captured"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/authorizations/voidauthorization"}],"panels":[]}]},"httpPath":"/authorizations/{authorization_id_void_to}"}],"content":{"contentType":"group","meta":{"name":"Authorizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorizations","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":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (also known as a card hold) reserves a specific amount on a card to be captured (i.e. debited) at a later date, usually within seven days. When an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is captured it produces a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/auth-and-captures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auth and Captures"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/level-2-level-3-processing/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 2 and 3 Processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/in-person-payments/building-your-integration/pos-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POS Integration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/authorizations","summary":"Create an Authorization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/authorizations/createauthorization","deprecated":false},{"title":"/authorizations","summary":"List Authorizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authorizations/listauthorizations","deprecated":false},{"title":"/authorizations/{authorization_id}","summary":"Fetch an Authorization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/authorizations/getauthorization","deprecated":false},{"title":"/authorizations/{authorization_id}","summary":"Capture an Authorization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/authorizations/captureauthorization","deprecated":false},{"title":"/authorizations/{authorization_id_void_to}","summary":"Void an Authorization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/authorizations/voidauthorization","deprecated":false}]}]}]}]}},{"type":"group","label":"Compliance Forms","link":"/api/compliance-forms","routeSlug":"/api/compliance-forms","items":[{"label":"Fetch a Compliance Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/compliance-forms/getcomplianceform","routeSlug":"/api/compliance-forms/getcomplianceform","metadata":{"seo":{"title":"Fetch a Compliance Form","description":"Finix sends a webhook whenever a new Compliance Form is created for your Merchant. Using the ID, you can retrieve the Compliance Form."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getComplianceForm","name":"Fetch a Compliance Form","isWebhook":false,"pointer":"/paths/~1compliance_forms~1{compliance_form_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Compliance Form","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":"text","inline":true,"attributes":{"content":"Finix sends a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/webhook-events#compliance-form-created"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whenever a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created for your Merchant. Using the ID, you can retrieve the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"compliance_form_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"cf_uwErNm23TKYNEiqrEdJK59"}],"pointer":"/paths/~1compliance_forms~1{compliance_form_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1compliance_forms~1{compliance_form_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance_forms/{compliance_form_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"compliance_form_id","in":"path","required":true,"example":"cf_uwErNm23TKYNEiqrEdJK59","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/compliance_forms/{compliance_form_id}","href":"compliance-forms/getcomplianceform","openApiOperationId":"getComplianceForm","summary":"Fetch a Compliance Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/compliance_form","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Unsigned Compliance Form","paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Signed Compliance Form"]}},"schemaId":"components/schemas/compliance_form","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Unsigned Compliance Form","paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Signed Compliance Form"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1compliance_forms~1{compliance_form_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/compliance_form","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Unsigned Compliance Form","paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Signed Compliance Form"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/compliance_form","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Unsigned Compliance Form","paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Signed Compliance Form"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/compliance-forms/getcomplianceform"}],"panels":[]}]},"httpPath":"/compliance_forms/{compliance_form_id}"},{"label":"Complete a Compliance Form","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/compliance-forms/updatecomplianceform","routeSlug":"/api/compliance-forms/updatecomplianceform","metadata":{"seo":{"title":"Complete a Compliance Form","description":"As part of onboarding, your Merchants need to review and agree to their Compliance Form. Afterward, you need to update their Compliance Form with details about their digital signature. Finix will update their Compliance Form with those details, along with a reference to the new signed_file with their digital signature."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateComplianceForm","name":"Complete a Compliance Form","isWebhook":false,"pointer":"/paths/~1compliance_forms~1{compliance_form_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Complete a Compliance Form","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":"text","inline":true,"attributes":{"content":"As part of onboarding, your Merchants need to review and agree to their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Afterward, you need to update their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with details about their digital signature. Finix will update their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with those details, along with a reference to the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signed_file"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with their digital signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/managing-pci-compliance#completing-compliance-forms"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing Compliance Forms"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"compliance_form_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"cf_uwErNm23TKYNEiqrEdJK59"}],"pointer":"/paths/~1compliance_forms~1{compliance_form_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/completeComplianceForm","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/requestBody/content/application~1json/examples/Complete a Compliance Form"]}},"schemaId":"components/schemas/completeComplianceForm","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/requestBody/content/application~1json/examples/Complete a Compliance Form"],"pointer":"/paths/~1compliance_forms~1{compliance_form_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/compliance_forms/{compliance_form_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"compliance_form_id","in":"path","required":true,"example":"cf_uwErNm23TKYNEiqrEdJK59","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/completeComplianceForm","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/requestBody/content/application~1json/examples/Complete a Compliance Form"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/compliance_forms/{compliance_form_id}","href":"compliance-forms/updatecomplianceform","openApiOperationId":"updateComplianceForm","summary":"Complete a Compliance Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/completeComplianceForm","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/requestBody/content/application~1json/examples/Complete a Compliance Form"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/completeComplianceForm","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/requestBody/content/application~1json/examples/Complete a Compliance Form"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/compliance_form","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/200/content/application~1json/examples/Completed Compliance Form"]}},"schemaId":"components/schemas/compliance_form","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/200/content/application~1json/examples/Completed Compliance Form"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1compliance_forms~1{compliance_form_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/compliance_form","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/200/content/application~1json/examples/Completed Compliance Form"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/compliance_form","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/200/content/application~1json/examples/Completed Compliance Form"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms~1{compliance_form_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/compliance-forms/updatecomplianceform"}],"panels":[]}]},"httpPath":"/compliance_forms/{compliance_form_id}"},{"label":"List Compliance Forms","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/compliance-forms/listcomplianceforms","routeSlug":"/api/compliance-forms/listcomplianceforms","metadata":{"seo":{"title":"List Compliance Forms","description":"Retrieve a list of Compliance Form resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listComplianceForms","name":"List Compliance Forms","isWebhook":false,"pointer":"/paths/~1compliance_forms/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Compliance Forms","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of Compliance Form resources."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"linked_to","in":"query","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the Compliance Form resource is linked to."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_31","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Compliance Form's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use comma-separated values to filter for multiple states (for example, you can specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?state=INCOMPLETE,EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"merchant_identity_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"IDhC29dXMAkbmr1aBpS91Hpx"},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1compliance_forms/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1compliance_forms/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/compliance_forms","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"linked_to","in":"query","example":"MUwfZPNW3r4EqLMzwgr6txw4","schemaId":"schema_30"},{"name":"state","in":"query","example":"COMPLETE","schemaId":"schema_31"},{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"merchant_identity_id","in":"query","example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/compliance_forms","href":"compliance-forms/listcomplianceforms","openApiOperationId":"listComplianceForms","summary":"List Compliance Forms"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/compliance_forms\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1compliance_forms/get/responses/200/content/application~1json/examples/List of Compliance Forms"]}},"schemaId":"schema_32","exampleIds":["paths/~1compliance_forms/get/responses/200/content/application~1json/examples/List of Compliance Forms"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1compliance_forms/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_32","exampleIds":["paths/~1compliance_forms/get/responses/200/content/application~1json/examples/List of Compliance Forms"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32","exampleIds":["paths/~1compliance_forms/get/responses/200/content/application~1json/examples/List of Compliance Forms"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1compliance_forms/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/compliance-forms/listcomplianceforms"}],"panels":[]}]},"httpPath":"/compliance_forms"}],"content":{"contentType":"group","meta":{"name":"Compliance Forms"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compliance Forms","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":"To process payments, your Merchants must validate their compliance with PCI DSS requirements annually. To do this, your Merchants must attest to PCI Self-Assessment Questionnaire (SAQ) compliance forms."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/managing-pci-compliance"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing PCI Compliance"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/pci-dss-compliance"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PCI DSS Compliance"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/compliance_forms/{compliance_form_id}","summary":"Fetch a Compliance Form","prefix":{"name":"get","color":"get"},"badges":[],"link":"/compliance-forms/getcomplianceform","deprecated":false},{"title":"/compliance_forms/{compliance_form_id}","summary":"Complete a Compliance Form","prefix":{"name":"put","color":"put"},"badges":[],"link":"/compliance-forms/updatecomplianceform","deprecated":false},{"title":"/compliance_forms","summary":"List Compliance Forms","prefix":{"name":"get","color":"get"},"badges":[],"link":"/compliance-forms/listcomplianceforms","deprecated":false}]}]}]}]}},{"type":"group","label":"Devices","link":"/api/devices","routeSlug":"/api/devices","items":[{"label":"List Devices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/listdevices","routeSlug":"/api/devices/listdevices","metadata":{"seo":{"title":"List Devices","description":"Retrieve a list of Devices."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDevices","name":"List Devices","isWebhook":false,"pointer":"/paths/~1devices/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Devices","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Devices"},"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":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"description","in":"query","schemaId":"schema_6","description":"Filter by the description."},{"name":"enabled","in":"query","schemaId":"schema_34","description":"Filter by the enabled value."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant_id","in":"query","schemaId":"schema_20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"merchant_identity_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"IDhC29dXMAkbmr1aBpS91Hpx"},{"name":"merchant_identity_id","in":"query","schemaId":"schema_35","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"name","in":"query","schemaId":"schema_36","description":"Filter by the name."},{"name":"model","in":"query","schemaId":"schema_37","description":"Filter by the model."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"serial_number","in":"query","schemaId":"schema_38","description":"Filter by the serial number."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1devices/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1devices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/devices","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"description","in":"query","required":false,"schemaId":"schema_6"},{"name":"enabled","in":"query","required":false,"example":true,"schemaId":"schema_34"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant_id","in":"query","example":"MUeDVrf2ahuKc9Eg5TeZugvs","schemaId":"schema_20"},{"name":"merchant_identity_id","in":"query","example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_6"},{"name":"merchant_identity_id","in":"query","example":"IDtEnKsZyJNUGK83ZTx4C45S","schemaId":"schema_35"},{"name":"name","in":"query","required":false,"example":"john%%20smith","schemaId":"schema_36"},{"name":"model","in":"query","required":false,"example":"PAX_A800","schemaId":"schema_37"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"serial_number","in":"query","required":false,"example":"2210074802","schemaId":"schema_38"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/devices","href":"devices/listdevices","openApiOperationId":"listDevices","summary":"List Devices"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/devices\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/~1devices/get/responses/200/content/application~1json/examples/List of Devices"]}},"schemaId":"schema_39","exampleIds":["paths/~1devices/get/responses/200/content/application~1json/examples/List of Devices"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1devices/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","exampleIds":["paths/~1devices/get/responses/200/content/application~1json/examples/List of Devices"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/~1devices/get/responses/200/content/application~1json/examples/List of Devices"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/listdevices"}],"panels":[]}]},"httpPath":"/devices"},{"label":"Fetch a Device","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/getdevice","routeSlug":"/api/devices/getdevice","metadata":{"seo":{"title":"Fetch a Device","description":"Retrieve the details of an existing Device."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDevice","name":"Fetch a Device","isWebhook":false,"pointer":"/paths/~1devices~1{device_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Device","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"device_id","in":"path","schemaId":"schema_6","description":[{"$$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":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"DV4fNUcRpAQdfobsgEpoxUEi"}],"pointer":"/paths/~1devices~1{device_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_connection","in":"query","schemaId":"schema_18","description":"Specifies whether the connection information should be included."}],"pointer":"/paths/~1devices~1{device_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1devices~1{device_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/devices/{device_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"device_id","in":"path","required":true,"example":"DV4fNUcRpAQdfobsgEpoxUEi","schemaId":"schema_6"}],"query":[{"name":"include_connection","in":"query","schemaId":"schema_18"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/devices/{device_id}","href":"devices/getdevice","openApiOperationId":"getDevice","summary":"Fetch a Device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id}/get/responses/200/content/application~1json/examples/Device"]}},"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id}/get/responses/200/content/application~1json/examples/Device"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1devices~1{device_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id}/get/responses/200/content/application~1json/examples/Device"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id}/get/responses/200/content/application~1json/examples/Device"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/getdevice"}],"panels":[]}]},"httpPath":"/devices/{device_id}"},{"label":"Update Device","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/updatedevice","routeSlug":"/api/devices/updatedevice","metadata":{"seo":{"title":"Update Device","description":"You can either update the configuration of a device or take an action on the device"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDevice","name":"Update Device","isWebhook":false,"pointer":"/paths/~1devices~1{device_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Device","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":"text","inline":true,"attributes":{"content":"You can either update the configuration of a device or take an action on the device"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminals must be online and connected to the network in order for the request to be successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can initiate an action on a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Actions supported vary by gateway."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FINIX_V1 and DUMMY_V1 terminals support the following actions:"},"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":"ACTIVATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Activate the device to enable processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEACTIVATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Deactivate the device to disable processing"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Cancel any active transaction and return to the idle screen"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For processors other than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", contact your Finix point of contact or email "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/getting-started/support-at-finix/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for device update instructions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use a PUT request to update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"configuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"serial_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"device_id","in":"path","schemaId":"schema_6","description":[{"$$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":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"DV4fNUcRpAQdfobsgEpoxUEi"}],"pointer":"/paths/~1devices~1{device_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Surcharges"]}},"schemaId":"schema_40","exampleIds":["paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Surcharges"],"pointer":"/paths/~1devices~1{device_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/devices/{device_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"device_id","in":"path","required":true,"example":"DV4fNUcRpAQdfobsgEpoxUEi","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Surcharges"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/devices/{device_id}","href":"devices/updatedevice","openApiOperationId":"updateDevice","summary":"Update Device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_40","exampleIds":["paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Surcharges"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_40","exampleIds":["paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Surcharges"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Surcharges"]}},"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Surcharges"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1devices~1{device_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Surcharges"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Activate","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Cancel","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Deactivate","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Idle File Image and Message","paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Surcharges"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/updatedevice"}],"panels":[]}]},"httpPath":"/devices/{device_id}"},{"label":"Check Device Connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/getdeviceconnection","routeSlug":"/api/devices/getdeviceconnection","metadata":{"seo":{"title":"Check Device Connection","description":"To check the connection of the Device, include ?include_connection=true at the end of the request endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDeviceConnection","name":"Check Device Connection","isWebhook":false,"pointer":"/paths/~1devices~1{device_id_connection}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Device Connection","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":"text","inline":true,"attributes":{"content":"To check the connection of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?include_connection=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the end of the request endpoint."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"device_id_connection","in":"path","schemaId":"schema_6","description":[{"$$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":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you wish to check the connection status of."},"children":[]}]}]}],"required":true,"example":"DV4fNUcRpAQdfobsgEpoxUEi"}],"pointer":"/paths/~1devices~1{device_id_connection}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_connection","in":"query","schemaId":"schema_18","description":"Specifies whether the connection information should be included.","required":true}],"pointer":"/paths/~1devices~1{device_id_connection}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1devices~1{device_id_connection}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/devices/{device_id_connection}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"device_id_connection","in":"path","required":true,"example":"DV4fNUcRpAQdfobsgEpoxUEi","schemaId":"schema_6"}],"query":[{"name":"include_connection","in":"query","required":true,"schemaId":"schema_18"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/devices/{device_id_connection}","href":"devices/getdeviceconnection","openApiOperationId":"getDeviceConnection","summary":"Check Device Connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/200/content/application~1json/examples/Device"]}},"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/200/content/application~1json/examples/Device"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1devices~1{device_id_connection}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/200/content/application~1json/examples/Device"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/device","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/200/content/application~1json/examples/Device"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id_connection}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/getdeviceconnection"}],"panels":[]}]},"httpPath":"/devices/{device_id_connection}"},{"label":"List Device Metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/listdevicemetrics","routeSlug":"/api/devices/listdevicemetrics","metadata":{"seo":{"title":"List Device Metrics","description":"Finix collects and analyzes data from payment devices and terminals to generate logs, known as Device Metric objects. Each Device Metric log provides insights into device health, network connectivity, and payment processing performance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDeviceMetrics","name":"List Device Metrics","isWebhook":false,"pointer":"/paths/~1devices~1{device_id}~1device_metrics/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Device Metrics","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":"text","inline":true,"attributes":{"content":"Finix collects and analyzes data from payment devices and terminals to generate logs, known as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device Metric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects. Each "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device Metric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" log provides insights into device health, network connectivity, and payment processing performance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to retrieve a device's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device Metric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" logs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"device_id","in":"path","schemaId":"schema_6","description":"The device whose logs you wish to view.","required":true,"example":"DV4fNUcRpAQdfobsgEpoxUEi"}],"pointer":"/paths/~1devices~1{device_id}~1device_metrics/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"connection","in":"query","schemaId":"schema_41","description":"Query logs based on the device's connection status (i.e., whether the device has an open or closed connection).\n"},{"name":"connectivity_network_type","in":"query","schemaId":"schema_42","description":"Query based on the type of network connection (e.g., Wi-Fi, cellular, ethernet)."},{"name":"connectivity_signal_strength","in":"query","schemaId":"schema_43","description":"Query based on the network connection strength."},{"name":"event_type","in":"query","schemaId":"schema_44","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query based on the type of event that triggered the generation of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device Metric"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"payment_app_state","in":"query","schemaId":"schema_45","description":"Query based on whether the payment application was running in the background or foreground on the device."},{"name":"payment_app_version","in":"query","schemaId":"schema_46","description":"Query based on the exact version of the payment application."},{"name":"payment_app_version.gte","in":"query","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified payment app version."},"children":[]}]}]}]},{"name":"payment_app_version.lte","in":"query","schemaId":"schema_46","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"less than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified payment app version."},"children":[]}]}]}]},{"name":"power_battery_level_percent","in":"query","schemaId":"schema_47","description":"Query the device's battery level percentage.\n"},{"name":"power_battery_level_percent.gte","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified battery level percentage."},"children":[]}]}]}]},{"name":"power_battery_level_percent.lte","in":"query","schemaId":"schema_47","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"less than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified battery level percentage."},"children":[]}]}]}]},{"name":"power_battery_temperature_celsius","in":"query","schemaId":"schema_48","description":"Query based on the device's battery temperature in Celsius.\n"},{"name":"power_battery_temperature_celsius.gte","in":"query","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified battery temperature in Celsius."},"children":[]}]}]}]},{"name":"power_battery_temperature_celsius.lte","in":"query","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"less than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified battery temperature in Celsius."},"children":[]}]}]}]},{"name":"power_battery_temperature_fahrenheit","in":"query","schemaId":"schema_48","description":"Query based on the device's battery temperature in Fahrenheit.\n"},{"name":"power_battery_temperature_fahrenheit.gte","in":"query","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified battery temperature in Fahrenheit."},"children":[]}]}]}]},{"name":"power_battery_temperature_fahrenheit.lte","in":"query","schemaId":"schema_48","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"less than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified battery temperature in Fahrenheit."},"children":[]}]}]}]},{"name":"power_is_charging","in":"query","schemaId":"schema_49","description":"Query whether the device was charging or not charging."},{"name":"system_android_version","in":"query","schemaId":"schema_50","description":"Query based on the Android operating system version installed on the device.\n"},{"name":"system_android_version.gte","in":"query","schemaId":"schema_50","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified Android operating system version."},"children":[]}]}]}]},{"name":"system_android_version.lte","in":"query","schemaId":"schema_50","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"less than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified Android operating system version."},"children":[]}]}]}]},{"name":"system_firmware_version","in":"query","schemaId":"schema_51","description":"Query based on the firmware version.\n"},{"name":"system_firmware_version.gte","in":"query","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"greater than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified firmware version."},"children":[]}]}]}]},{"name":"system_firmware_version.lte","in":"query","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"less than"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"equal to"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the specified firmware version."},"children":[]}]}]}]}],"pointer":"/paths/~1devices~1{device_id}~1device_metrics/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1devices~1{device_id}~1device_metrics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/devices/{device_id}/device_metrics","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"device_id","in":"path","required":true,"example":"DV4fNUcRpAQdfobsgEpoxUEi","schemaId":"schema_6"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"connection","in":"query","required":false,"example":"OPEN","schemaId":"schema_41"},{"name":"connectivity_network_type","in":"query","required":false,"example":"WIFI","schemaId":"schema_42"},{"name":"connectivity_signal_strength","in":"query","required":false,"example":"POOR","schemaId":"schema_43"},{"name":"event_type","in":"query","required":false,"example":"SCHEDULED_INTERVAL","schemaId":"schema_44"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"payment_app_state","in":"query","required":false,"example":"BACKGROUND","schemaId":"schema_45"},{"name":"payment_app_version","in":"query","required":false,"example":"3.2.1","schemaId":"schema_46"},{"name":"payment_app_version.gte","in":"query","required":false,"example":"3.2.1","schemaId":"schema_46"},{"name":"payment_app_version.lte","in":"query","required":false,"example":"3.2.1","schemaId":"schema_46"},{"name":"power_battery_level_percent","in":"query","required":false,"example":"75","schemaId":"schema_47"},{"name":"power_battery_level_percent.gte","in":"query","required":false,"example":"75","schemaId":"schema_47"},{"name":"power_battery_level_percent.lte","in":"query","required":false,"example":"75","schemaId":"schema_47"},{"name":"power_battery_temperature_celsius","in":"query","required":false,"example":"32.5","schemaId":"schema_48"},{"name":"power_battery_temperature_celsius.gte","in":"query","required":false,"example":"32.5","schemaId":"schema_48"},{"name":"power_battery_temperature_celsius.lte","in":"query","required":false,"example":"32.5","schemaId":"schema_48"},{"name":"power_battery_temperature_fahrenheit","in":"query","required":false,"example":"32.5","schemaId":"schema_48"},{"name":"power_battery_temperature_fahrenheit.gte","in":"query","required":false,"example":"32.5","schemaId":"schema_48"},{"name":"power_battery_temperature_fahrenheit.lte","in":"query","required":false,"example":"32.5","schemaId":"schema_48"},{"name":"power_is_charging","in":"query","required":false,"example":"true","schemaId":"schema_49"},{"name":"system_android_version","in":"query","required":false,"example":"12","schemaId":"schema_50"},{"name":"system_android_version.gte","in":"query","required":false,"example":"12","schemaId":"schema_50"},{"name":"system_android_version.lte","in":"query","required":false,"example":"12","schemaId":"schema_50"},{"name":"system_firmware_version","in":"query","required":false,"example":"2.1.0","schemaId":"schema_51"},{"name":"system_firmware_version.gte","in":"query","required":false,"example":"2.1.0","schemaId":"schema_51"},{"name":"system_firmware_version.lte","in":"query","required":false,"example":"2.1.0","schemaId":"schema_51"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/devices/{device_id}/device_metrics","href":"devices/listdevicemetrics","openApiOperationId":"listDeviceMetrics","summary":"List Device Metrics"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/devices/DVhXqP9onzhA7sxheKXoBc3J/device_metrics\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/200/content/application~1json/examples/List of Devices"]}},"schemaId":"schema_39","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/200/content/application~1json/examples/List of Devices"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1devices~1{device_id}~1device_metrics/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/200/content/application~1json/examples/List of Devices"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/200/content/application~1json/examples/List of Devices"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1devices~1{device_id}~1device_metrics/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/listdevicemetrics"}],"panels":[]}]},"httpPath":"/devices/{device_id}/device_metrics"},{"label":"Create a Merchant Device","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/devices/createmerchantdevice","routeSlug":"/api/devices/createmerchantdevice","metadata":{"seo":{"title":"Create a Merchant Device","description":"Create a Device under a Merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMerchantDevice","name":"Create a Merchant Device","isWebhook":false,"pointer":"/paths/~1merchants~1{merchant_id}~1devices/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Merchant Device","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchant_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be created under."},"children":[]}]}]}],"required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4"}],"pointer":"/paths/~1merchants~1{merchant_id}~1devices/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1merchants~1{merchant_id}~1devices/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"]}},"schemaId":"schema_52","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"],"pointer":"/paths/~1merchants~1{merchant_id}~1devices/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/merchants/{merchant_id}/devices","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"merchant_id","in":"path","required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"]}},"responseCodes":["201","400","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/merchants/{merchant_id}/devices","href":"devices/createmerchantdevice","openApiOperationId":"createMerchantDevice","summary":"Create a Merchant Device"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_52","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_52","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Request to create a device under a merchant.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/device","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"]}},"schemaId":"components/schemas/device","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"]},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid model","paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid integration_mode"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid model","paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid integration_mode"]}],"pointer":"/paths/~1merchants~1{merchant_id}~1devices/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/device","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/device","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A800","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A920PRO","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_D135","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_IM30","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - SDK Mode","paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid model","paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid integration_mode"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid model","paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid integration_mode"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/devices/createmerchantdevice"}],"panels":[]}]},"httpPath":"/merchants/{merchant_id}/devices"}],"content":{"contentType":"group","meta":{"name":"Devices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Devices","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents a Point-of-Sale terminal. Devices are used for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/in-person-payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-Person transactions"},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/in-person-payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In-Person Payments"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/devices","summary":"List Devices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/listdevices","deprecated":false},{"title":"/devices/{device_id}","summary":"Fetch a Device","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/getdevice","deprecated":false},{"title":"/devices/{device_id}","summary":"Update Device","prefix":{"name":"put","color":"put"},"badges":[],"link":"/devices/updatedevice","deprecated":false},{"title":"/devices/{device_id_connection}","summary":"Check Device Connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/getdeviceconnection","deprecated":false},{"title":"/devices/{device_id}/device_metrics","summary":"List Device Metrics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/devices/listdevicemetrics","deprecated":false},{"title":"/merchants/{merchant_id}/devices","summary":"Create a Merchant Device","prefix":{"name":"post","color":"post"},"badges":[],"link":"/devices/createmerchantdevice","deprecated":false}]}]}]}]}},{"type":"group","label":"Disputes","link":"/api/disputes","routeSlug":"/api/disputes","items":[{"label":"List Disputes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/listdisputes","routeSlug":"/api/disputes/listdisputes","metadata":{"seo":{"title":"List Disputes","description":"Retrieve a list of Dispute resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDisputes","name":"List Disputes","isWebhook":false,"pointer":"/paths/~1disputes/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Disputes","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"adjustment_transfer_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the ID of the adjustment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"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":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If included, all other filter parameters are ignored."},"children":[]}]}]}]},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"amount","in":"query","schemaId":"schema_7","description":"Filter by an amount equal to the given value."},{"name":"amount.gt","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than."},{"name":"amount.gte","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than or equal."},{"name":"amount.lt","in":"query","schemaId":"schema_7","description":"Filter by an amount less than."},{"name":"amount.lte","in":"query","schemaId":"schema_7","description":"Filter by an amount less than or equal."},{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"buyer_identity_first_name","in":"query","schemaId":"schema_6","description":"Filter by buyer's first name."},{"name":"buyer_identity_last_name","in":"query","schemaId":"schema_6","description":"Filter by buyer's last name."},{"name":"buyer_business_name","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"buyer_doing_business_as","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doing_business_as"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"instrument_bin","in":"query","schemaId":"schema_6","description":"Filter by the Bank Identification Number (BIN). The BIN is the first 6 digits of the masked account number."},{"name":"instrument_brand_type","in":"query","schemaId":"schema_6","description":"Filter by the card brand used."},{"name":"instrument_card_last4","in":"query","schemaId":"schema_6","description":"Filter by the last 4 digits of the card used."},{"name":"instrument_card_type","in":"query","schemaId":"schema_6","description":"Filter by the card type."},{"name":"instrument_fingerprint","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the fingerprint of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"instrument_name","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"instrument_type","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant_identity_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"merchant_identity_name","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the name used by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"merchant_identity_name.like","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the name used by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use this when searching with only partial name values."},"children":[]}]}]}]},{"name":"merchant_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"merchant_mid","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the MID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"names","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the name used by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the buyer's first and last name, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doing_business_as"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when role is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUYER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"names.like","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the name used by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the buyer's first and last name, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doing_business_as"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when role is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUYER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use this when searching with only partial values."},"children":[]}]}]}]},{"name":"response_state","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"response_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"respond_by.lte","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"respond_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"respond_by.gte","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"respond_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"tags","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of tags."},"children":[]}]}]}]},{"name":"tags.like","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of tags. Use this when searching with only partial values."},"children":[]}]}]}]},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"transfer_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that's being disputed. "},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If included, all other filter parameters are ignored."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"adjustment_transfer_id","in":"query","schemaId":"schema_6"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"},{"name":"amount","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"buyer_identity_first_name","in":"query","schemaId":"schema_6"},{"name":"buyer_identity_last_name","in":"query","schemaId":"schema_6"},{"name":"buyer_business_name","in":"query","schemaId":"schema_6"},{"name":"buyer_doing_business_as","in":"query","schemaId":"schema_6"},{"name":"instrument_bin","in":"query","schemaId":"schema_6"},{"name":"instrument_brand_type","in":"query","schemaId":"schema_6"},{"name":"instrument_card_last4","in":"query","schemaId":"schema_6"},{"name":"instrument_card_type","in":"query","schemaId":"schema_6"},{"name":"instrument_fingerprint","in":"query","schemaId":"schema_6"},{"name":"instrument_name","in":"query","schemaId":"schema_6"},{"name":"instrument_type","in":"query","schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant_identity_id","in":"query","schemaId":"schema_6"},{"name":"merchant_identity_name","in":"query","schemaId":"schema_6"},{"name":"merchant_identity_name.like","in":"query","schemaId":"schema_6"},{"name":"merchant_id","in":"query","schemaId":"schema_6"},{"name":"merchant_mid","in":"query","schemaId":"schema_6"},{"name":"names","in":"query","schemaId":"schema_6"},{"name":"names.like","in":"query","schemaId":"schema_6"},{"name":"response_state","in":"query","schemaId":"schema_6"},{"name":"respond_by.lte","in":"query","schemaId":"schema_6"},{"name":"respond_by.gte","in":"query","schemaId":"schema_6"},{"name":"tags","in":"query","schemaId":"schema_6"},{"name":"tags.like","in":"query","schemaId":"schema_6"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"transfer_id","in":"query","schemaId":"schema_6"},{"name":"state","in":"query","schemaId":"schema_6"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes","href":"disputes/listdisputes","openApiOperationId":"listDisputes","summary":"List Disputes"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/disputes\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1disputes/get/responses/200/content/application~1json/examples/List of Disputes"]}},"schemaId":"schema_53","exampleIds":["paths/~1disputes/get/responses/200/content/application~1json/examples/List of Disputes"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1disputes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_53","exampleIds":["paths/~1disputes/get/responses/200/content/application~1json/examples/List of Disputes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53","exampleIds":["paths/~1disputes/get/responses/200/content/application~1json/examples/List of Disputes"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/listdisputes"}],"panels":[]}]},"httpPath":"/disputes"},{"label":"Fetch a Dispute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/getdispute","routeSlug":"/api/disputes/getdispute","metadata":{"seo":{"title":"Fetch a Dispute","description":"Retrieve the details of an existing Dispute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDispute","name":"Fetch a Dispute","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Dispute","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"}],"pointer":"/paths/~1disputes~1{dispute_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes/{dispute_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}","href":"disputes/getdispute","openApiOperationId":"getDispute","summary":"Fetch a Dispute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Needs Response","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Chargeback","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Won","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Lost","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Lost","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Won"]}},"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Needs Response","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Chargeback","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Won","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Lost","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Lost","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Won"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1disputes~1{dispute_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Needs Response","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Chargeback","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Won","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Lost","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Lost","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Won"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Needs Response","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Chargeback","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Won","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Lost","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Lost","paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Won"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/getdispute"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}"},{"label":"Update Dispute","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/updatedispute","routeSlug":"/api/disputes/updatedispute","metadata":{"seo":{"title":"Update Dispute","description":"Update tags on a Dispute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDispute","name":"Update Dispute","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Dispute","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":"text","inline":true,"attributes":{"content":"Update "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"}],"pointer":"/paths/~1disputes~1{dispute_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/requestBody/content/application~1json/examples/Update Dispute"]}},"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/requestBody/content/application~1json/examples/Update Dispute"],"pointer":"/paths/~1disputes~1{dispute_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/disputes/{dispute_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/requestBody/content/application~1json/examples/Update Dispute"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}","href":"disputes/updatedispute","openApiOperationId":"updateDispute","summary":"Update Dispute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/requestBody/content/application~1json/examples/Update Dispute"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/requestBody/content/application~1json/examples/Update Dispute"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Needs Response","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Chargeback","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Won","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Lost","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Lost","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Won"]}},"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Needs Response","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Chargeback","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Won","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Lost","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Lost","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Won"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1disputes~1{dispute_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Needs Response","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Chargeback","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Won","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Lost","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Lost","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Won"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Needs Response","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Chargeback","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Won","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Lost","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Lost","paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Won"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/updatedispute"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}"},{"label":"Upload Files as Dispute Evidence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/createdisputeevidence","routeSlug":"/api/disputes/createdisputeevidence","metadata":{"seo":{"title":"Upload Files as Dispute Evidence","description":"Upload a file as evidence for a Dispute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDisputeEvidence","name":"Upload Files as Dispute Evidence","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload Files as Dispute Evidence","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":"text","inline":true,"attributes":{"content":"Upload a file as evidence for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"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":"text","inline":true,"attributes":{"content":"You can upload up to 8 files; the total size of the uploaded files combined cannot exceed 10 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The allowed file formats include JPEG, PDF, PNG."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual JPEG, PDF, PNG files can't exceed 1 MB."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PNG files will be automatically converted and returned as JPEG files."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/uploadDisputeEvidence"}},"schemaId":"components/schemas/uploadDisputeEvidence","pointer":"/paths/~1disputes~1{dispute_id}~1evidence/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/disputes/{dispute_id}/evidence","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/uploadDisputeEvidence"}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/evidence","href":"disputes/createdisputeevidence","openApiOperationId":"createDisputeEvidence","summary":"Upload Files as Dispute Evidence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/uploadDisputeEvidence","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/uploadDisputeEvidence"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/201/content/application~1json/examples/Dispute Evidence"]}},"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/201/content/application~1json/examples/Dispute Evidence"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/201/content/application~1json/examples/Dispute Evidence"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/201/content/application~1json/examples/Dispute Evidence"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/createdisputeevidence"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/evidence"},{"label":"List Dispute Evidence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/listdisputesevidence","routeSlug":"/api/disputes/listdisputesevidence","metadata":{"seo":{"title":"List Dispute Evidence","description":"Retrieve a list of Dispute Evidence for a Dispute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDisputesEvidence","name":"List Dispute Evidence","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Dispute Evidence","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes/{dispute_id}/evidence","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/evidence","href":"disputes/listdisputesevidence","openApiOperationId":"listDisputesEvidence","summary":"List Dispute Evidence"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/200/content/application~1json/examples/List of Dispute Evidence Resources"]}},"schemaId":"schema_55","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/200/content/application~1json/examples/List of Dispute Evidence Resources"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_55","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/200/content/application~1json/examples/List of Dispute Evidence Resources"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_55","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/200/content/application~1json/examples/List of Dispute Evidence Resources"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/listdisputesevidence"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/evidence"},{"label":"Fetch Dispute Evidence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/getdisputeevidence","routeSlug":"/api/disputes/getdisputeevidence","metadata":{"seo":{"title":"Fetch Dispute Evidence","description":"Fetch evidence uploaded for a Dispute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDisputeEvidence","name":"Fetch Dispute Evidence","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch Dispute Evidence","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":"text","inline":true,"attributes":{"content":"Fetch evidence uploaded for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"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 Finix Dashboard is unavailable, you can fetch the evidence to review the upload "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and confirm it was sent to the processor."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch evidence for."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"},{"name":"evidence_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch."},"children":[]}]}]}],"required":true,"example":"DFet8gXGsH4kXmDWdLhHoKco"}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes/{dispute_id}/evidence/{evidence_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"},{"name":"evidence_id","in":"path","required":true,"example":"DFet8gXGsH4kXmDWdLhHoKco","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/evidence/{evidence_id}","href":"disputes/getdisputeevidence","openApiOperationId":"getDisputeEvidence","summary":"Fetch Dispute Evidence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/200/content/application~1json/examples/Dispute Evidence"]}},"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/200/content/application~1json/examples/Dispute Evidence"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/200/content/application~1json/examples/Dispute Evidence"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/200/content/application~1json/examples/Dispute Evidence"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/getdisputeevidence"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/evidence/{evidence_id}"},{"label":"Update Dispute Evidence","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/updatedisputeevidence","routeSlug":"/api/disputes/updatedisputeevidence","metadata":{"seo":{"title":"Update Dispute Evidence","description":"Update tags on Dispute Evidence."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDisputeEvidence","name":"Update Dispute Evidence","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Dispute Evidence","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":"text","inline":true,"attributes":{"content":"Update "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch evidence for."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"},{"name":"evidence_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch."},"children":[]}]}]}],"required":true,"example":"DFet8gXGsH4kXmDWdLhHoKco"}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/requestBody/content/application~1json/examples/Update Dispute"]}},"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/requestBody/content/application~1json/examples/Update Dispute"],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/disputes/{dispute_id}/evidence/{evidence_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"},{"name":"evidence_id","in":"path","required":true,"example":"DFet8gXGsH4kXmDWdLhHoKco","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/requestBody/content/application~1json/examples/Update Dispute"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/evidence/{evidence_id}","href":"disputes/updatedisputeevidence","openApiOperationId":"updateDisputeEvidence","summary":"Update Dispute Evidence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/requestBody/content/application~1json/examples/Update Dispute"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/requestBody/content/application~1json/examples/Update Dispute"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/200/content/application~1json/examples/Dispute Evidence"]}},"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/200/content/application~1json/examples/Dispute Evidence"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/200/content/application~1json/examples/Dispute Evidence"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/200/content/application~1json/examples/Dispute Evidence"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/updatedisputeevidence"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/evidence/{evidence_id}"},{"label":"Delete Dispute Evidence","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/deletedisputeevidence","routeSlug":"/api/disputes/deletedisputeevidence","metadata":{"seo":{"title":"Delete Dispute Evidence","description":"Delete a Dispute Evidence file. You can delete evidence files only before a Dispute and its uploaded evidence are submitted for the first time, and only on FINIX_V1 or DUMMY_V1."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDisputeEvidence","name":"Delete Dispute Evidence","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Dispute Evidence","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":"text","inline":true,"attributes":{"content":"Delete a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" file. You can delete evidence files only before a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and its uploaded evidence are submitted for the first time, and only on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch evidence for."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"},{"name":"evidence_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to fetch."},"children":[]}]}]}],"required":true,"example":"DFet8gXGsH4kXmDWdLhHoKco"}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/disputes/{dispute_id}/evidence/{evidence_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"},{"name":"evidence_id","in":"path","required":true,"example":"DFet8gXGsH4kXmDWdLhHoKco","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["204","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/evidence/{evidence_id}","href":"disputes/deletedisputeevidence","openApiOperationId":"deleteDisputeEvidence","summary":"Delete Dispute Evidence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted. No resource to return."},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unprocessable Entity. The parameters were valid, but the request failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible error causes"},"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":"text","inline":true,"attributes":{"content":"Deletion of dispute evidence files is not allowed for merchants not on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/422/content/application~1json/examples/Merchant not on FINIX_V1 or DUMMY_V1"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/422/content/application~1json/examples/Merchant not on FINIX_V1 or DUMMY_V1"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/422/content/application~1json/examples/Merchant not on FINIX_V1 or DUMMY_V1"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/422/content/application~1json/examples/Merchant not on FINIX_V1 or DUMMY_V1"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/deletedisputeevidence"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/evidence/{evidence_id}"},{"label":"List Dispute Adjustment Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/listdisputesadjustments","routeSlug":"/api/disputes/listdisputesadjustments","metadata":{"seo":{"title":"List Dispute Adjustment Transfers","description":"List the adjustment Transfers for a Dispute. Depending on the stage of the Dispute, different adjustment Transfer subtypes can be applied."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDisputesAdjustments","name":"List Dispute Adjustment Transfers","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1adjustment_transfers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Dispute Adjustment Transfers","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":"text","inline":true,"attributes":{"content":"List the adjustment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Depending on the stage of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", different adjustment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subtypes can be applied."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are four available subtypes for adjustment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disputes"},"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":"PLATFORM_CREDIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MERCHANT_DEBIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MERCHANT_CREDIT"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLATFORM_DEBIT"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"}],"pointer":"/paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes/{dispute_id}/adjustment_transfers","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/adjustment_transfers","href":"disputes/listdisputesadjustments","openApiOperationId":"listDisputesAdjustments","summary":"List Dispute Adjustment Transfers"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of balance adjustment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/200/content/application~1json/examples/List of Adjustment Transfers in a Dispute:"]}},"schemaId":"schema_56","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/200/content/application~1json/examples/List of Adjustment Transfers in a Dispute:"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/404/content/application~1json/examples/Not found"]}},"exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_56","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/200/content/application~1json/examples/List of Adjustment Transfers in a Dispute:"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/200/content/application~1json/examples/List of Adjustment Transfers in a Dispute:"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/listdisputesadjustments"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/adjustment_transfers"},{"label":"Submit Dispute Evidence","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/submitdisputeevidence","routeSlug":"/api/disputes/submitdisputeevidence","metadata":{"seo":{"title":"Submit Dispute Evidence","description":"You can submit evidence to the issuing bank, confirming that the Merchant has completed submitting evidence and is ready to proceed with the Dispute."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"submitDisputeEvidence","name":"Submit Dispute Evidence","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1submit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit Dispute Evidence","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":"text","inline":true,"attributes":{"content":"You can submit evidence to the issuing bank, confirming that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has completed submitting evidence and is ready to proceed with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"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":"Related guides: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/disputes/responding-to-disputes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responding to Disputes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move forward and submit evidence."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"}],"pointer":"/paths/~1disputes~1{dispute_id}~1submit/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1submit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/submitDisputeEvidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/requestBody/content/application~1json/examples/Submit Dispute Evidence"]}},"schemaId":"components/schemas/submitDisputeEvidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/requestBody/content/application~1json/examples/Submit Dispute Evidence"],"pointer":"/paths/~1disputes~1{dispute_id}~1submit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/disputes/{dispute_id}/submit","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/submitDisputeEvidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/requestBody/content/application~1json/examples/Submit Dispute Evidence"]}},"responseCodes":["202","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/submit","href":"disputes/submitdisputeevidence","openApiOperationId":"submitDisputeEvidence","summary":"Submit Dispute Evidence"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/submitDisputeEvidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/requestBody/content/application~1json/examples/Submit Dispute Evidence"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/submitDisputeEvidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/requestBody/content/application~1json/examples/Submit Dispute Evidence"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/202/content/application~1json/examples/Dispute Evidence"]}},"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/202/content/application~1json/examples/Dispute Evidence"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1submit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/202/content/application~1json/examples/Dispute Evidence"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute_evidence","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/202/content/application~1json/examples/Dispute Evidence"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1submit/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/submitdisputeevidence"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/submit"},{"label":"Accept a Dispute","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/acceptdispute","routeSlug":"/api/disputes/acceptdispute","metadata":{"seo":{"title":"Accept a Dispute","description":"You can accept a Dispute to prevent a long (and potentially expensive) process. When you accept a Dispute, you concede that the Dispute is not worth challenging or representing."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"acceptDispute","name":"Accept a Dispute","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1accept/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accept a Dispute","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":"text","inline":true,"attributes":{"content":"You can accept a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to prevent a long (and potentially expensive) process. When you accept a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you concede that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not worth challenging or representing."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related guides: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/disputes/accepting-disputes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepting a Dispute"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to move forward and submit evidence."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"}],"pointer":"/paths/~1disputes~1{dispute_id}~1accept/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1accept/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/acceptDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/requestBody/content/application~1json/examples/Accept Dispute"]}},"schemaId":"components/schemas/acceptDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/requestBody/content/application~1json/examples/Accept Dispute"],"pointer":"/paths/~1disputes~1{dispute_id}~1accept/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/disputes/{dispute_id}/accept","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_54"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/acceptDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/requestBody/content/application~1json/examples/Accept Dispute"]}},"responseCodes":["202","400","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/accept","href":"disputes/acceptdispute","openApiOperationId":"acceptDispute","summary":"Accept a Dispute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/acceptDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/requestBody/content/application~1json/examples/Accept Dispute"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/acceptDispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/requestBody/content/application~1json/examples/Accept Dispute"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/202/content/application~1json/examples/Dispute - Accepted"]}},"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/202/content/application~1json/examples/Dispute - Accepted"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/422/content/application~1json/examples/Cannot accept after evidence submitted"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/422/content/application~1json/examples/Cannot accept after evidence submitted"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1accept/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/202/content/application~1json/examples/Dispute - Accepted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/dispute","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/202/content/application~1json/examples/Dispute - Accepted"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/422/content/application~1json/examples/Cannot accept after evidence submitted"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1accept/post/responses/422/content/application~1json/examples/Cannot accept after evidence submitted"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/acceptdispute"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/accept"},{"label":"Download Dispute Evidence","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disputes/downloaddisputeevidence","routeSlug":"/api/disputes/downloaddisputeevidence","metadata":{"seo":{"title":"Download Dispute Evidence","description":"Download a file uploaded as Dispute Evidence."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadDisputeEvidence","name":"Download Dispute Evidence","isWebhook":false,"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download Dispute Evidence","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":"text","inline":true,"attributes":{"content":"Download a file uploaded as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute Evidence"},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The file extension included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"output"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must match the extension of the original uploaded file."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"dispute_id","in":"path","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download evidence from."},"children":[]}]}]}],"required":true,"example":"DIgDv9764vkkEVu1suZNCDbR"},{"name":"evidence_id","in":"path","schemaId":"schema_58","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"evidence"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to download."},"children":[]}]}]}],"required":true,"example":"DFet8gXGsH4kXmDWdLhHoKco"}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disputes/{dispute_id}/evidence/{evidence_id}/download","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"dispute_id","in":"path","required":true,"example":"DIgDv9764vkkEVu1suZNCDbR","schemaId":"schema_57"},{"name":"evidence_id","in":"path","required":true,"example":"DFet8gXGsH4kXmDWdLhHoKco","schemaId":"schema_58"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disputes/{dispute_id}/evidence/{evidence_id}/download","href":"disputes/downloaddisputeevidence","openApiOperationId":"downloadDisputeEvidence","summary":"Download Dispute Evidence"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco/download\" \\\n    -H \"Finix-Version: 2022-02-01\" \\\n    -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \\\n    --output evidence-download.jpg\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File Download"},"children":[]}]}]}],"mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/file_download","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/200/content/application~1octet-stream/examples/Download Begins"]}},"schemaId":"components/schemas/file_download","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/200/content/application~1octet-stream/examples/Download Begins"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/file_download","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/200/content/application~1octet-stream/examples/Download Begins"],"mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/file_download","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/200/content/application~1octet-stream/examples/Download Begins"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disputes/downloaddisputeevidence"}],"panels":[]}]},"httpPath":"/disputes/{dispute_id}/evidence/{evidence_id}/download"}],"content":{"contentType":"group","meta":{"name":"Disputes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disputes","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":"Disputes, also known as chargebacks, are customer-disputed charges. A core part of the dispute lifecycle is the ability for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to upload evidence supporting their side."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/disputes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing Disputes"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/disputes","summary":"List Disputes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/listdisputes","deprecated":false},{"title":"/disputes/{dispute_id}","summary":"Fetch a Dispute","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/getdispute","deprecated":false},{"title":"/disputes/{dispute_id}","summary":"Update Dispute","prefix":{"name":"put","color":"put"},"badges":[],"link":"/disputes/updatedispute","deprecated":false},{"title":"/disputes/{dispute_id}/evidence","summary":"Upload Files as Dispute Evidence","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/createdisputeevidence","deprecated":false},{"title":"/disputes/{dispute_id}/evidence","summary":"List Dispute Evidence","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/listdisputesevidence","deprecated":false},{"title":"/disputes/{dispute_id}/evidence/{evidence_id}","summary":"Fetch Dispute Evidence","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/getdisputeevidence","deprecated":false},{"title":"/disputes/{dispute_id}/evidence/{evidence_id}","summary":"Update Dispute Evidence","prefix":{"name":"put","color":"put"},"badges":[],"link":"/disputes/updatedisputeevidence","deprecated":false},{"title":"/disputes/{dispute_id}/evidence/{evidence_id}","summary":"Delete Dispute Evidence","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/disputes/deletedisputeevidence","deprecated":false},{"title":"/disputes/{dispute_id}/adjustment_transfers","summary":"List Dispute Adjustment Transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/listdisputesadjustments","deprecated":false},{"title":"/disputes/{dispute_id}/submit","summary":"Submit Dispute Evidence","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/submitdisputeevidence","deprecated":false},{"title":"/disputes/{dispute_id}/accept","summary":"Accept a Dispute","prefix":{"name":"post","color":"post"},"badges":[],"link":"/disputes/acceptdispute","deprecated":false},{"title":"/disputes/{dispute_id}/evidence/{evidence_id}/download","summary":"Download Dispute Evidence","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disputes/downloaddisputeevidence","deprecated":false}]}]}]}]}},{"type":"group","label":"Fees","link":"/api/fees","routeSlug":"/api/fees","items":[{"label":"List Fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/listfees","routeSlug":"/api/fees/listfees","metadata":{"seo":{"title":"List Fees","description":"Retrieve a list of Fee resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFees","name":"List Fees","isWebhook":false,"pointer":"/paths/~1fees/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Fees","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"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":"Filter fees by linked entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You can filter fees by the entity that generated them using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter:"},"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":"Transfer fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=TRnErBfrHLgdAi3BqAkWLN27"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=AUg8unYpnWBEY1AdVUDkdQYJ"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split transfer fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=split_transfer_split_transfer_97gaitUpcmzqjYYpQbei9j"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance Form fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=cf_uwErNm23TKYNEiqrEdJK59"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=PInVUXZLswZi6pdcK1T41MuE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant-specific fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=MUwfZPNW3r4EqLMzwgr6txw4"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant-specific fees include monthly dues and assessments and any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/fees/createfee"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom fees"},"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":"To show fees charged to a specific entity during a period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at.gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at.lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"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":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?merchant_id=MUeDVrf2ahuKc9Eg5TeZugvs&created_at.lte=2025-01-01&created_at.gte=2025-02-01"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"linked_to","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the resource that generated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"TRrB2VG7H84LmRgSTkfR2Cb6"},{"name":"merchant_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was charged fees."},"children":[]}]}]}],"example":"MUeDVrf2ahuKc9Eg5TeZugvs"},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1fees/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1fees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"linked_to","in":"query","required":false,"example":"TRrB2VG7H84LmRgSTkfR2Cb6","schemaId":"schema_6"},{"name":"merchant_id","in":"query","required":false,"example":"MUeDVrf2ahuKc9Eg5TeZugvs","schemaId":"schema_6"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/fees","href":"fees/listfees","openApiOperationId":"listFees","summary":"List Fees"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/fees\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"]}},"schemaId":"schema_59","exampleIds":["paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1fees/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_59","exampleIds":["paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/listfees"}],"panels":[]}]},"httpPath":"/fees"},{"label":"Create a Custom Fee","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/createfee","routeSlug":"/api/fees/createfee","metadata":{"seo":{"title":"Create a Custom Fee","description":"Create a custom (i.e. one-time) Fee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createfee","name":"Create a Custom Fee","isWebhook":false,"pointer":"/paths/~1fees/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Custom Fee","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":"text","inline":true,"attributes":{"content":"Create a custom (i.e. one-time) "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1fees/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createCustomFee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/Fee"]}},"schemaId":"components/schemas/createCustomFee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/Fee"],"pointer":"/paths/~1fees/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fees","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createCustomFee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/Fee"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/fees","href":"fees/createfee","openApiOperationId":"createfee","summary":"Create a Custom Fee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createCustomFee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/Fee"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createCustomFee","exampleIds":["paths/~1fees/post/requestBody/content/application~1json/examples/Fee"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Single Custom Fee object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees/post/responses/201/content/application~1json/examples/Fee"]}},"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees/post/responses/201/content/application~1json/examples/Fee"],"headers":{"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"date":{"$ref":"#/components/headers/date"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1fees/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/fee","exampleIds":["paths/~1fees/post/responses/201/content/application~1json/examples/Fee"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees/post/responses/201/content/application~1json/examples/Fee"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/createfee"}],"panels":[]}]},"httpPath":"/fees"},{"label":"Fetch a Fee","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/getfee","routeSlug":"/api/fees/getfee","metadata":{"seo":{"title":"Fetch a Fee","description":"Retrieve the details of an existing Fee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFee","name":"Fetch a Fee","isWebhook":false,"pointer":"/paths/~1fees~1{fee_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Fee","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fee_id","in":"path","schemaId":"schema_60","description":[{"$$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":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"FEvjF5iPwy6zuUEsBWgJ9T79"}],"pointer":"/paths/~1fees~1{fee_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1fees~1{fee_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees/{fee_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"fee_id","in":"path","required":true,"example":"FEvjF5iPwy6zuUEsBWgJ9T79","schemaId":"schema_60"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/fees/{fee_id}","href":"fees/getfee","openApiOperationId":"getFee","summary":"Fetch a Fee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees~1{fee_id}/get/responses/200/content/application~1json/examples/Fee"]}},"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees~1{fee_id}/get/responses/200/content/application~1json/examples/Fee"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1fees~1{fee_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/fee","exampleIds":["paths/~1fees~1{fee_id}/get/responses/200/content/application~1json/examples/Fee"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees~1{fee_id}/get/responses/200/content/application~1json/examples/Fee"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/getfee"}],"panels":[]}]},"httpPath":"/fees/{fee_id}"},{"label":"Update Fee","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fees/updatefee","routeSlug":"/api/fees/updatefee","metadata":{"seo":{"title":"Update Fee","description":"Update the details of a Fee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFee","name":"Update Fee","isWebhook":false,"pointer":"/paths/~1fees~1{fee_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Fee","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":"text","inline":true,"attributes":{"content":"Update the details of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fee_id","in":"path","schemaId":"schema_60","description":[{"$$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":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"FEvjF5iPwy6zuUEsBWgJ9T79"}],"pointer":"/paths/~1fees~1{fee_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1fees~1{fee_id}/put/requestBody/content/application~1json/examples/Update Fee"]}},"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1fees~1{fee_id}/put/requestBody/content/application~1json/examples/Update Fee"],"pointer":"/paths/~1fees~1{fee_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/fees/{fee_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"fee_id","in":"path","required":true,"example":"FEvjF5iPwy6zuUEsBWgJ9T79","schemaId":"schema_60"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1fees~1{fee_id}/put/requestBody/content/application~1json/examples/Update Fee"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/fees/{fee_id}","href":"fees/updatefee","openApiOperationId":"updateFee","summary":"Update Fee"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1fees~1{fee_id}/put/requestBody/content/application~1json/examples/Update Fee"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1fees~1{fee_id}/put/requestBody/content/application~1json/examples/Update Fee"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees~1{fee_id}/put/responses/200/content/application~1json/examples/Fee"]}},"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees~1{fee_id}/put/responses/200/content/application~1json/examples/Fee"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1fees~1{fee_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/fee","exampleIds":["paths/~1fees~1{fee_id}/put/responses/200/content/application~1json/examples/Fee"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee","exampleIds":["paths/~1fees~1{fee_id}/put/responses/200/content/application~1json/examples/Fee"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees~1{fee_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fees/updatefee"}],"panels":[]}]},"httpPath":"/fees/{fee_id}"}],"content":{"contentType":"group","meta":{"name":"Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fees","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a charge levied against a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It represents how a platform charges its sellers for all various types of Fees."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fees","summary":"List Fees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/listfees","deprecated":false},{"title":"/fees","summary":"Create a Custom Fee","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fees/createfee","deprecated":false},{"title":"/fees/{fee_id}","summary":"Fetch a Fee","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fees/getfee","deprecated":false},{"title":"/fees/{fee_id}","summary":"Update Fee","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fees/updatefee","deprecated":false}]}]}]}]}},{"type":"group","label":"Fee Profiles","link":"/api/fee-profiles","routeSlug":"/api/fee-profiles","items":[{"label":"Create a Fee Profile","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fee-profiles/createfeeprofile","routeSlug":"/api/fee-profiles/createfeeprofile","metadata":{"seo":{"title":"Create a Fee Profile","description":"Create a Fee Profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFeeProfile","name":"Create a Fee Profile","isWebhook":false,"pointer":"/paths/~1fee_profiles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Fee Profile","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1fee_profiles/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_61","exampleIds":["paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/No Fees"]}},"schemaId":"schema_61","exampleIds":["paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/No Fees"],"pointer":"/paths/~1fee_profiles/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fee_profiles","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_61","exampleIds":["paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/No Fees"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/fee_profiles","href":"fee-profiles/createfeeprofile","openApiOperationId":"createFeeProfile","summary":"Create a Fee Profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_61","exampleIds":["paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/No Fees"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_61","exampleIds":["paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/requestBody/content/application~1json/examples/No Fees"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Fee Profile","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee_profile","exampleIds":["paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/No Fees"]}},"schemaId":"components/schemas/fee_profile","exampleIds":["paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/No Fees"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1fee_profiles/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/fee_profile","exampleIds":["paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/No Fees"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee_profile","exampleIds":["paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Blended Profile","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus Profile","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus and Dues and Assessments","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/All Fields","paths/~1fee_profiles/post/responses/201/content/application~1json/examples/No Fees"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fee-profiles/createfeeprofile"}],"panels":[]}]},"httpPath":"/fee_profiles"},{"label":"List Fee Profiles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fee-profiles/listfeeprofiles","routeSlug":"/api/fee-profiles/listfeeprofiles","metadata":{"seo":{"title":"List Fee Profiles","description":"Retrieve a list of Fee Profile resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFeeProfiles","name":"List Fee Profiles","isWebhook":false,"pointer":"/paths/~1fee_profiles/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Fee Profiles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve a list of Fee Profile resources."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1fee_profiles/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1fee_profiles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fee_profiles","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/fee_profiles","href":"fee-profiles/listfeeprofiles","openApiOperationId":"listFeeProfiles","summary":"List Fee Profiles"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/fee_profiles\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62","exampleIds":["paths/~1fee_profiles/get/responses/200/content/application~1json/examples/List of Fee Profiles"]}},"schemaId":"schema_62","exampleIds":["paths/~1fee_profiles/get/responses/200/content/application~1json/examples/List of Fee Profiles"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1fee_profiles/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_62","exampleIds":["paths/~1fee_profiles/get/responses/200/content/application~1json/examples/List of Fee Profiles"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_62","exampleIds":["paths/~1fee_profiles/get/responses/200/content/application~1json/examples/List of Fee Profiles"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fee-profiles/listfeeprofiles"}],"panels":[]}]},"httpPath":"/fee_profiles"},{"label":"Fetch a Fee Profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/fee-profiles/getfeeprofile","routeSlug":"/api/fee-profiles/getfeeprofile","metadata":{"seo":{"title":"Fetch a Fee Profile","description":"Retrieve the details of an existing Fee Profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFeeProfile","name":"Fetch a Fee Profile","isWebhook":false,"pointer":"/paths/~1fee_profiles~1{fee_profile_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Fee Profile","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fee_profile_id","in":"path","schemaId":"schema_6","description":[{"$$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":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"FPuizPqrhzYLbmJm88u7aqfj"}],"pointer":"/paths/~1fee_profiles~1{fee_profile_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1fee_profiles~1{fee_profile_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fee_profiles/{fee_profile_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"fee_profile_id","in":"path","required":true,"example":"FPuizPqrhzYLbmJm88u7aqfj","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/fee_profiles/{fee_profile_id}","href":"fee-profiles/getfeeprofile","openApiOperationId":"getFeeProfile","summary":"Fetch a Fee Profile"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee_profile","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/200/content/application~1json/examples/Fee Profile"]}},"schemaId":"components/schemas/fee_profile","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/200/content/application~1json/examples/Fee Profile"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1fee_profiles~1{fee_profile_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/fee_profile","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/200/content/application~1json/examples/Fee Profile"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/fee_profile","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/200/content/application~1json/examples/Fee Profile"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fee_profiles~1{fee_profile_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fee-profiles/getfeeprofile"}],"panels":[]}]},"httpPath":"/fee_profiles/{fee_profile_id}"}],"content":{"contentType":"group","meta":{"name":"Fee Profiles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fee Profiles","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee_profiles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents a pricing scheme that automatically applies fees to each transaction. Changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee_profiles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" go into effect immediately."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/platform-payments/monetizing-payments/merchant-fee-profiles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant Fee Profiles"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fee_profiles","summary":"Create a Fee Profile","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fee-profiles/createfeeprofile","deprecated":false},{"title":"/fee_profiles","summary":"List Fee Profiles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fee-profiles/listfeeprofiles","deprecated":false},{"title":"/fee_profiles/{fee_profile_id}","summary":"Fetch a Fee Profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fee-profiles/getfeeprofile","deprecated":false}]}]}]}]}},{"type":"group","label":"Files","link":"/api/files","routeSlug":"/api/files","items":[{"label":"Create a File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/createfile","routeSlug":"/api/files/createfile","metadata":{"seo":{"title":"Create a File","description":"Before uploading a file, you must create a File resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createFile","name":"Create a File","isWebhook":false,"pointer":"/paths/~1files/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a File","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":"text","inline":true,"attributes":{"content":"Before uploading a file, you must create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Once created, you can "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-uploading-files/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upload"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" your file to the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createFile","exampleIds":["paths/~1files/post/requestBody/content/application~1json/examples/File"]}},"schemaId":"components/schemas/createFile","exampleIds":["paths/~1files/post/requestBody/content/application~1json/examples/File"],"pointer":"/paths/~1files/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createFile","exampleIds":["paths/~1files/post/requestBody/content/application~1json/examples/File"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/files","href":"files/createfile","openApiOperationId":"createFile","summary":"Create a File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createFile","exampleIds":["paths/~1files/post/requestBody/content/application~1json/examples/File"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createFile","exampleIds":["paths/~1files/post/requestBody/content/application~1json/examples/File"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/file","exampleIds":["paths/~1files/post/responses/201/content/application~1json/examples/File"]}},"schemaId":"components/schemas/file","exampleIds":["paths/~1files/post/responses/201/content/application~1json/examples/File"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1files/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/file","exampleIds":["paths/~1files/post/responses/201/content/application~1json/examples/File"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/file","exampleIds":["paths/~1files/post/responses/201/content/application~1json/examples/File"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/createfile"}],"panels":[]}]},"httpPath":"/files"},{"label":"List Files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/listfiles","routeSlug":"/api/files/listfiles","metadata":{"seo":{"title":"List Files","description":"Retrieve a list of File resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFiles","name":"List Files","isWebhook":false,"pointer":"/paths/~1files/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Files","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1files/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/files","href":"files/listfiles","openApiOperationId":"listFiles","summary":"List Files"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/files\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63","exampleIds":["paths/~1files/get/responses/200/content/application~1json/examples/List of Files"]}},"schemaId":"schema_63","exampleIds":["paths/~1files/get/responses/200/content/application~1json/examples/List of Files"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1files/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_63","exampleIds":["paths/~1files/get/responses/200/content/application~1json/examples/List of Files"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_63","exampleIds":["paths/~1files/get/responses/200/content/application~1json/examples/List of Files"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/listfiles"}],"panels":[]}]},"httpPath":"/files"},{"label":"Fetch a File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/getfile","routeSlug":"/api/files/getfile","metadata":{"seo":{"title":"Fetch a File","description":"Retrieve the details of an existing File."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFile","name":"Fetch a File","isWebhook":false,"pointer":"/paths/~1files~1{file_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a File","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_id","in":"path","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw"}],"pointer":"/paths/~1files~1{file_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{file_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{file_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"file_id","in":"path","required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw","schemaId":"schema_64"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/files/{file_id}","href":"files/getfile","openApiOperationId":"getFile","summary":"Fetch a File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A single File","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/file","exampleIds":["paths/~1files~1{file_id}/get/responses/200/content/application~1json/examples/File"]}},"schemaId":"components/schemas/file","exampleIds":["paths/~1files~1{file_id}/get/responses/200/content/application~1json/examples/File"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1files~1{file_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/file","exampleIds":["paths/~1files~1{file_id}/get/responses/200/content/application~1json/examples/File"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/file","exampleIds":["paths/~1files~1{file_id}/get/responses/200/content/application~1json/examples/File"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getfile"}],"panels":[]}]},"httpPath":"/files/{file_id}"},{"label":"List External Links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/listexternallinks","routeSlug":"/api/files/listexternallinks","metadata":{"seo":{"title":"List External Links","description":"List the previously created External Link resources for a File."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExternalLinks","name":"List External Links","isWebhook":false,"pointer":"/paths/~1files~1{file_id}~1external_links/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List External Links","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":"text","inline":true,"attributes":{"content":"List the previously created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_id","in":"path","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw"}],"pointer":"/paths/~1files~1{file_id}~1external_links/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{file_id}~1external_links/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{file_id}~1external_links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{file_id}/external_links","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"file_id","in":"path","required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw","schemaId":"schema_64"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"id","in":"query","schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/files/{file_id}/external_links","href":"files/listexternallinks","openApiOperationId":"listExternalLinks","summary":"List External Links"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/200/content/application~1json/examples/List of External Links"]}},"schemaId":"schema_65","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/200/content/application~1json/examples/List of External Links"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1files~1{file_id}~1external_links/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/200/content/application~1json/examples/List of External Links"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/200/content/application~1json/examples/List of External Links"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/listexternallinks"}],"panels":[]}]},"httpPath":"/files/{file_id}/external_links"},{"label":"Create an External Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/createexternallink","routeSlug":"/api/files/createexternallink","metadata":{"seo":{"title":"Create an External Link","description":"Create an External Link to share with users so they can upload files directly from their browser. For more info, see Uploading files to Finix."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExternalLink","name":"Create an External Link","isWebhook":false,"pointer":"/paths/~1files~1{file_id}~1external_links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an External Link","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":"text","inline":true,"attributes":{"content":"Create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to share with users so they can upload files directly from their browser. For more info, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-uploading-files/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploading files to Finix"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_id","in":"path","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw"}],"pointer":"/paths/~1files~1{file_id}~1external_links/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{file_id}~1external_links/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_66","exampleIds":["paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - View"]}},"schemaId":"schema_66","exampleIds":["paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - View"],"pointer":"/paths/~1files~1{file_id}~1external_links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files/{file_id}/external_links","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"file_id","in":"path","required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw","schemaId":"schema_64"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_66","exampleIds":["paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - View"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/files/{file_id}/external_links","href":"files/createexternallink","openApiOperationId":"createExternalLink","summary":"Create an External Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_66","exampleIds":["paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - View"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_66","exampleIds":["paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - View"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External Link"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_link","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - View"]}},"schemaId":"components/schemas/external_link","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - View"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1files~1{file_id}~1external_links/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/external_link","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - View"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_link","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Upload","paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Download","paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - View"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/createexternallink"}],"panels":[]}]},"httpPath":"/files/{file_id}/external_links"},{"label":"Upload a File","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/uploadfile","routeSlug":"/api/files/uploadfile","metadata":{"seo":{"title":"Upload a File","description":"Upload files directly with a multipart/form-data request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadFile","name":"Upload a File","isWebhook":false,"pointer":"/paths/~1files~1{file_id}~1upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a File","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":"text","inline":true,"attributes":{"content":"Upload files directly with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_id","in":"path","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was created to upload the file."},"children":[]}]}]}],"required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw"}],"pointer":"/paths/~1files~1{file_id}~1upload/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"multipart/form-data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{file_id}~1upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/uploadFile"}},"schemaId":"components/schemas/uploadFile","pointer":"/paths/~1files~1{file_id}~1upload/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/files/{file_id}/upload","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"file_id","in":"path","required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw","schemaId":"schema_64"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"multipart/form-data","schemaId":"schema_67"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/uploadFile"}},"responseCodes":["200","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/files/{file_id}/upload","href":"files/uploadfile","openApiOperationId":"uploadFile","summary":"Upload a File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/uploadFile","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/uploadFile"}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/file","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploading","paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploaded"]}},"schemaId":"components/schemas/file","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploading","paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploaded"],"headers":{"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"date":{"$ref":"#/components/headers/date"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1files~1{file_id}~1upload/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/file","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploading","paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploaded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/file","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploading","paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploaded"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1upload/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/uploadfile"}],"panels":[]}]},"httpPath":"/files/{file_id}/upload"},{"label":"Download a File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/downloadfile file that was uploaded to a `file` resource.","routeSlug":"/api/files/downloadfile file that was uploaded to a `file` resource.","metadata":{"seo":{"title":"Download a File","description":"Download a File"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadFile file that was uploaded to a `File` resource.","name":"Download a File","isWebhook":false,"pointer":"/paths/~1files~1{file_id}~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download a File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_id","in":"path","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was created to upload the file."},"children":[]}]}]}],"required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw"}],"pointer":"/paths/~1files~1{file_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"stream","in":"query","schemaId":"schema_18","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Stream the contents of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so it's displayed inline in the user's web browser."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{file_id}~1download/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{file_id}~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{file_id}/download","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"file_id","in":"path","required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw","schemaId":"schema_64"}],"query":[{"name":"stream","in":"query","schemaId":"schema_18"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/files/{file_id}/download","href":"files/downloadfile file that was uploaded to a `file` resource.","openApiOperationId":"downloadFile file that was uploaded to a `File` resource.","summary":"Download a File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File Download"},"children":[]}]}]}],"mediaType":"application/octet-stream","mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/file_download","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/200/content/application~1octet-stream/example"]}},"schemaId":"components/schemas/file_download","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/200/content/application~1octet-stream/example"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1files~1{file_id}~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/file_download","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/200/content/application~1octet-stream/example"],"mediaTypes":["application/octet-stream"],"mediaTypeContent":{"application/octet-stream":{"schemaId":"components/schemas/file_download","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/200/content/application~1octet-stream/example"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/downloadfile file that was uploaded to a `file` resource."}],"panels":[]}]},"httpPath":"/files/{file_id}/download"},{"label":"Fetch an External Link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/files/getexternallink","routeSlug":"/api/files/getexternallink","metadata":{"seo":{"title":"Fetch an External Link","description":"Fetch a previously created External Link resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExternalLink","name":"Fetch an External Link","isWebhook":false,"pointer":"/paths/~1files~1{file_id}~1external_links~1{external_link_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch an External Link","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":"text","inline":true,"attributes":{"content":"Fetch a previously created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"file_id","in":"path","schemaId":"schema_64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that has the links you want to retrieve."},"children":[]}]}]}],"required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw"},{"name":"external_link_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"external_link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that you want to retrieve."},"children":[]}]}]}],"required":true,"example":"EL_9NjudbF2eCjjdKnPu3UjL1"}],"pointer":"/paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/files/{file_id}/external_links/{external_link_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"file_id","in":"path","required":true,"example":"FILE_nWs5V6yyBVAyBe2vNWcqzw","schemaId":"schema_64"},{"name":"external_link_id","in":"path","required":true,"example":"EL_9NjudbF2eCjjdKnPu3UjL1","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/files/{file_id}/external_links/{external_link_id}","href":"files/getexternallink","openApiOperationId":"getExternalLink","summary":"Fetch an External Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External Link"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_link","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/200/content/application~1json/examples/External Link"]}},"schemaId":"components/schemas/external_link","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/200/content/application~1json/examples/External Link"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/external_link","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/200/content/application~1json/examples/External Link"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/external_link","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/200/content/application~1json/examples/External Link"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/files/getexternallink"}],"panels":[]}]},"httpPath":"/files/{file_id}/external_links/{external_link_id}"}],"content":{"contentType":"group","meta":{"name":"Files"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Files","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":"Use Finix's File API to upload and manage files for your merchants."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-uploading-files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"File Uploads"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-update-requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update Requests"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/files","summary":"Create a File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/createfile","deprecated":false},{"title":"/files","summary":"List Files","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/listfiles","deprecated":false},{"title":"/files/{file_id}","summary":"Fetch a File","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getfile","deprecated":false},{"title":"/files/{file_id}/external_links","summary":"List External Links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/listexternallinks","deprecated":false},{"title":"/files/{file_id}/external_links","summary":"Create an External Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/createexternallink","deprecated":false},{"title":"/files/{file_id}/upload","summary":"Upload a File","prefix":{"name":"post","color":"post"},"badges":[],"link":"/files/uploadfile","deprecated":false},{"title":"/files/{file_id}/download","summary":"Download a File","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/downloadfile file that was uploaded to a `file` resource.","deprecated":false},{"title":"/files/{file_id}/external_links/{external_link_id}","summary":"Fetch an External Link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/files/getexternallink","deprecated":false}]}]}]}]}},{"type":"group","label":"Identities","link":"/api/identities","routeSlug":"/api/identities","items":[{"label":"Create an Identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/createidentity","routeSlug":"/api/identities/createidentity","metadata":{"seo":{"title":"Create an Identity","description":"Create an Identity for your Buyer, Recipient, or Seller, using identity_roles and type to indicate the type of Identity you're creating."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createIdentity","name":"Create an Identity","isWebhook":false,"pointer":"/paths/~1identities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Identity","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":"text","inline":true,"attributes":{"content":"Create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for your Buyer, Recipient, or Seller, using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity_roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate the type of Identity you're creating."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related Guides: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/getting-started/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1identities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_68","exampleIds":["paths/~1identities/post/requestBody/content/application~1json/examples/Seller (USA)","paths/~1identities/post/requestBody/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Business)"]}},"schemaId":"schema_68","exampleIds":["paths/~1identities/post/requestBody/content/application~1json/examples/Seller (USA)","paths/~1identities/post/requestBody/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Business)"],"pointer":"/paths/~1identities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/identities","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_68","exampleIds":["paths/~1identities/post/requestBody/content/application~1json/examples/Seller (USA)","paths/~1identities/post/requestBody/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Business)"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/identities","href":"identities/createidentity","openApiOperationId":"createIdentity","summary":"Create an Identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_68","exampleIds":["paths/~1identities/post/requestBody/content/application~1json/examples/Seller (USA)","paths/~1identities/post/requestBody/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Business)"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_68","exampleIds":["paths/~1identities/post/requestBody/content/application~1json/examples/Seller (USA)","paths/~1identities/post/requestBody/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer","paths/~1identities/post/requestBody/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Business)"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Single Identity object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities/post/responses/201/content/application~1json/examples/Seller (USA)","paths/~1identities/post/responses/201/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/responses/201/content/application~1json/examples/Buyer","paths/~1identities/post/responses/201/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Business)"]}},"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities/post/responses/201/content/application~1json/examples/Seller (USA)","paths/~1identities/post/responses/201/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/responses/201/content/application~1json/examples/Buyer","paths/~1identities/post/responses/201/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Business)"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1identities/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/identity","exampleIds":["paths/~1identities/post/responses/201/content/application~1json/examples/Seller (USA)","paths/~1identities/post/responses/201/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/responses/201/content/application~1json/examples/Buyer","paths/~1identities/post/responses/201/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Business)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities/post/responses/201/content/application~1json/examples/Seller (USA)","paths/~1identities/post/responses/201/content/application~1json/examples/Seller (CAN)","paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Business)","paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Personal)","paths/~1identities/post/responses/201/content/application~1json/examples/Buyer","paths/~1identities/post/responses/201/content/application~1json/examples/Buyer - Blank","paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Business)"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/createidentity"}],"panels":[]}]},"httpPath":"/identities"},{"label":"List Identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/listidentities","routeSlug":"/api/identities/listidentities","metadata":{"seo":{"title":"List Identities","description":"Retrieve a list the previously created Identities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listIdentities","name":"List Identities","isWebhook":false,"pointer":"/paths/~1identities/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Identities","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":"text","inline":true,"attributes":{"content":"Retrieve a list the previously created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identities"},"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":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no query parameters are specified in the request the API automatically limits the response to records from the last 30 days. You can request older data by passing an explicit created_at.lte filter."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"business_name","in":"query","schemaId":"schema_69","description":"Filter by the full business name. Partial business names are not supported."},{"name":"business_type","in":"query","schemaId":"schema_70","description":"Filter by the business type. Partial business types are not supported."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"default_statement_descriptor","in":"query","schemaId":"schema_69","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default_statement_descriptor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"email","in":"query","schemaId":"schema_71","description":"Filter by the email address or email domain. Partial emails are not supported."},{"name":"first_name","in":"query","schemaId":"schema_21","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the first name of the person associated to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"identity_role","in":"query","schemaId":"schema_72","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the role of the person associated to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"last_name","in":"query","schemaId":"schema_73","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the last name of the person associated to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"title","in":"query","schemaId":"schema_74","description":"Filter by the title if available."},{"name":"type","in":"query","schemaId":"schema_75","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1identities/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1identities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/identities","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"business_name","in":"query","required":false,"example":"Finix%20Flowers","schemaId":"schema_69"},{"name":"business_type","in":"query","required":false,"example":"INDIVIDUAL_SOLE_PROPRIETORSHIP","schemaId":"schema_70"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"default_statement_descriptor","in":"query","example":"Finix%20Flowers","schemaId":"schema_69"},{"name":"email","in":"query","required":false,"example":"user@example.org","schemaId":"schema_71"},{"name":"first_name","in":"query","required":false,"example":"John","schemaId":"schema_21"},{"name":"id","in":"query","schemaId":"schema_6"},{"name":"identity_role","in":"query","required":false,"example":"SELLER","schemaId":"schema_72"},{"name":"last_name","in":"query","required":false,"example":"Smith","schemaId":"schema_73"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"title","in":"query","required":false,"example":"ceo","schemaId":"schema_74"},{"name":"type","in":"query","required":false,"example":"BUSINESS","schemaId":"schema_75"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/identities","href":"identities/listidentities","openApiOperationId":"listIdentities","summary":"List Identities"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/identities\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Identity objects","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1identities/get/responses/200/content/application~1json/examples/List of Identities"]}},"schemaId":"schema_76","exampleIds":["paths/~1identities/get/responses/200/content/application~1json/examples/List of Identities"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1identities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_76","exampleIds":["paths/~1identities/get/responses/200/content/application~1json/examples/List of Identities"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1identities/get/responses/200/content/application~1json/examples/List of Identities"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/listidentities"}],"panels":[]}]},"httpPath":"/identities"},{"label":"Fetch an Identity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/getidentity","routeSlug":"/api/identities/getidentity","metadata":{"seo":{"title":"Fetch an Identity","description":"Retrieve the details of a previously created Identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentity","name":"Fetch an Identity","isWebhook":false,"pointer":"/paths/~1identities~1{identity_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch an Identity","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":"text","inline":true,"attributes":{"content":"Retrieve the details of a previously created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity_id","in":"path","schemaId":"schema_77","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx"}],"pointer":"/paths/~1identities~1{identity_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1identities~1{identity_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/identities/{identity_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"identity_id","in":"path","required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_77"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/identities/{identity_id}","href":"identities/getidentity","openApiOperationId":"getIdentity","summary":"Fetch an Identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Single Identity object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (USA)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (CAN)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Business)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Personal)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer - Blank","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Business)"]}},"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (USA)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (CAN)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Business)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Personal)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer - Blank","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Business)"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1identities~1{identity_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (USA)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (CAN)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Business)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Personal)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer - Blank","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Business)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (USA)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (CAN)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Business)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Personal)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer - Blank","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Business)"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/getidentity"}],"panels":[]}]},"httpPath":"/identities/{identity_id}"},{"label":"Update an Identity","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/updateidentity","routeSlug":"/api/identities/updateidentity","metadata":{"seo":{"title":"Update an Identity","description":"Update an existing Identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateIdentity","name":"Update an Identity","isWebhook":false,"pointer":"/paths/~1identities~1{identity_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an Identity","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":"text","inline":true,"attributes":{"content":"Update an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"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 you are updating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that’s already been onboarded, you need to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createMerchantVerification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"verify the merchant again"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity_id","in":"path","schemaId":"schema_77","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx"}],"pointer":"/paths/~1identities~1{identity_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateIdentity","exampleIds":["paths/~1identities~1{identity_id}/put/requestBody/content/application~1json/examples/Update an Identity"]}},"schemaId":"components/schemas/updateIdentity","exampleIds":["paths/~1identities~1{identity_id}/put/requestBody/content/application~1json/examples/Update an Identity"],"pointer":"/paths/~1identities~1{identity_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/identities/{identity_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"identity_id","in":"path","required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_77"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateIdentity","exampleIds":["paths/~1identities~1{identity_id}/put/requestBody/content/application~1json/examples/Update an Identity"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/identities/{identity_id}","href":"identities/updateidentity","openApiOperationId":"updateIdentity","summary":"Update an Identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/updateIdentity","exampleIds":["paths/~1identities~1{identity_id}/put/requestBody/content/application~1json/examples/Update an Identity"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateIdentity","exampleIds":["paths/~1identities~1{identity_id}/put/requestBody/content/application~1json/examples/Update an Identity"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Single Identity object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (USA)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (CAN)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Business)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Personal)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer - Blank","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Business)"]}},"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (USA)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (CAN)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Business)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Personal)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer - Blank","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Business)"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1identities~1{identity_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (USA)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (CAN)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Business)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Personal)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer - Blank","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Business)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (USA)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (CAN)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Business)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Personal)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer - Blank","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Personal)","paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Business)"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/updateidentity"}],"panels":[]}]},"httpPath":"/identities/{identity_id}"},{"label":"Create an Associated Identity","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/createassociatedidentity","routeSlug":"/api/identities/createassociatedidentity","metadata":{"seo":{"title":"Create an Associated Identity","description":"Create an associated Identity for every owner with 25% or more ownership over the merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAssociatedIdentity","name":"Create an Associated Identity","isWebhook":false,"pointer":"/paths/~1identities~1{identity_id}~1associated_identities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Associated Identity","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":"text","inline":true,"attributes":{"content":"Create an associated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-via-api#step-3-add-associated-identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"every owner with 25% or more ownership"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" over the merchant."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity_id","in":"path","schemaId":"schema_77","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the beneficial owner from which you wish to create the associated identity."},"children":[]}]}]}],"required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx"}],"pointer":"/paths/~1identities~1{identity_id}~1associated_identities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createAssociatedIdentity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/requestBody/content/application~1json/examples/Associated Identity"]}},"schemaId":"components/schemas/createAssociatedIdentity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/requestBody/content/application~1json/examples/Associated Identity"],"pointer":"/paths/~1identities~1{identity_id}~1associated_identities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/identities/{identity_id}/associated_identities","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"identity_id","in":"path","required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_77"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createAssociatedIdentity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/requestBody/content/application~1json/examples/Associated Identity"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/identities/{identity_id}/associated_identities","href":"identities/createassociatedidentity","openApiOperationId":"createAssociatedIdentity","summary":"Create an Associated Identity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createAssociatedIdentity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/requestBody/content/application~1json/examples/Associated Identity"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createAssociatedIdentity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/requestBody/content/application~1json/examples/Associated Identity"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Associated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" successfully created."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/201/content/application~1json/examples/Associated Identity"]}},"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/201/content/application~1json/examples/Associated Identity"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1identities~1{identity_id}~1associated_identities/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/201/content/application~1json/examples/Associated Identity"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/identity","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/201/content/application~1json/examples/Associated Identity"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/createassociatedidentity"}],"panels":[]}]},"httpPath":"/identities/{identity_id}/associated_identities"},{"label":"List Associated Identities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/listidentityassociatedidentities","routeSlug":"/api/identities/listidentityassociatedidentities","metadata":{"seo":{"title":"List Associated Identities","description":"Retrieve a list of Associated Identities for an Identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listIdentityAssociatedIdentities","name":"List Associated Identities","isWebhook":false,"pointer":"/paths/~1identities~1{identity_id}~1associated_identities/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Associated Identities","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Associated Identities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"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":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity_id","in":"path","schemaId":"schema_77","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the beneficial owner from which you wish to create the associated identity."},"children":[]}]}]}],"required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx"}],"pointer":"/paths/~1identities~1{identity_id}~1associated_identities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."}],"pointer":"/paths/~1identities~1{identity_id}~1associated_identities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/identities/{identity_id}/associated_identities","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"identity_id","in":"path","required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_77"}],"query":[{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/identities/{identity_id}/associated_identities","href":"identities/listidentityassociatedidentities","openApiOperationId":"listIdentityAssociatedIdentities","summary":"List Associated Identities"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Identity objects","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/200/content/application~1json/examples/List of Identities"]}},"schemaId":"schema_76","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/200/content/application~1json/examples/List of Identities"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1identities~1{identity_id}~1associated_identities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_76","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/200/content/application~1json/examples/List of Identities"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_76","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/200/content/application~1json/examples/List of Identities"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1associated_identities/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/listidentityassociatedidentities"}],"panels":[]}]},"httpPath":"/identities/{identity_id}/associated_identities"},{"label":"Fetch an Identity's Merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/identities/getidentitymerchant","routeSlug":"/api/identities/getidentitymerchant","metadata":{"seo":{"title":"Fetch an Identity's Merchant","description":"Retrieve the Merchant resource for an Identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdentityMerchant","name":"Fetch an Identity's Merchant","isWebhook":false,"pointer":"/paths/~1identities~1{identity_id}~1merchants/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch an Identity's Merchant","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":"text","inline":true,"attributes":{"content":"Retrieve the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity_id","in":"path","schemaId":"schema_77","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx"}],"pointer":"/paths/~1identities~1{identity_id}~1merchants/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1identities~1{identity_id}~1merchants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/identities/{identity_id}/merchants","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"identity_id","in":"path","required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_77"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/identities/{identity_id}/merchants","href":"identities/getidentitymerchant","openApiOperationId":"getIdentityMerchant","summary":"Fetch an Identity's Merchant"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/identities/ID6NvZy42D7PChZL8GKKD87F/merchants\" \\\n    -H \"Content-Type: application/json\" \\\n    -H \"Finix-Version: 2022-02-01\" \\\n    -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"]}},"schemaId":"schema_78","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1identities~1{identity_id}~1merchants/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_78","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/identities/getidentitymerchant"}],"panels":[]}]},"httpPath":"/identities/{identity_id}/merchants"}],"content":{"contentType":"group","meta":{"name":"Identities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Identities","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":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents either a person or business in Finix. You'll create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to onboard your sellers, and verify the different owners."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/getting-started"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding Sellers"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/card-payouts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push to Card"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/identities","summary":"Create an Identity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/identities/createidentity","deprecated":false},{"title":"/identities","summary":"List Identities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identities/listidentities","deprecated":false},{"title":"/identities/{identity_id}","summary":"Fetch an Identity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identities/getidentity","deprecated":false},{"title":"/identities/{identity_id}","summary":"Update an Identity","prefix":{"name":"put","color":"put"},"badges":[],"link":"/identities/updateidentity","deprecated":false},{"title":"/identities/{identity_id}/associated_identities","summary":"Create an Associated Identity","prefix":{"name":"post","color":"post"},"badges":[],"link":"/identities/createassociatedidentity","deprecated":false},{"title":"/identities/{identity_id}/associated_identities","summary":"List Associated Identities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identities/listidentityassociatedidentities","deprecated":false},{"title":"/identities/{identity_id}/merchants","summary":"Fetch an Identity's Merchant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/identities/getidentitymerchant","deprecated":false}]}]}]}]}},{"type":"group","label":"Merchants","link":"/api/merchants","routeSlug":"/api/merchants","items":[{"label":"Create a Merchant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/createmerchant","routeSlug":"/api/merchants/createmerchant","metadata":{"seo":{"title":"Create a Merchant","description":"Create a Merchant to start the underwriting (also called provisioning) process for your seller. Merchants must be created under an Identity."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMerchant","name":"Create a Merchant","isWebhook":false,"pointer":"/paths/~1identities~1{identity_id}~1merchants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Merchant","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to start the underwriting (also called provisioning) process for your seller. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be created under an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Identities"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"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":"A bank account must be associated with the previously created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be successfully onboarded and verified."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"identity_id","in":"path","schemaId":"schema_77","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx"}],"pointer":"/paths/~1identities~1{identity_id}~1merchants/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1identities~1{identity_id}~1merchants/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Refunds Disabled"]}},"schemaId":"schema_79","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Refunds Disabled"],"pointer":"/paths/~1identities~1{identity_id}~1merchants/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/identities/{identity_id}/merchants","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"identity_id","in":"path","required":true,"example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_77"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Refunds Disabled"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/identities/{identity_id}/merchants","href":"merchants/createmerchant","openApiOperationId":"createMerchant","summary":"Create a Merchant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_79","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Refunds Disabled"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_79","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Refunds Disabled"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Single Merchant object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchant","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Refunds Disabled"]}},"schemaId":"components/schemas/merchant","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Refunds Disabled"],"headers":{"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"date":{"$ref":"#/components/headers/date"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1identities~1{identity_id}~1merchants/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/merchant","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Refunds Disabled"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchant","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Minimal Fields","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - All Fields","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Card Present Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Default Partial Authorization Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Loan Repayment Enabled","paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Refunds Disabled"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1identities~1{identity_id}~1merchants/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/createmerchant"}],"panels":[]}]},"httpPath":"/identities/{identity_id}/merchants"},{"label":"List Merchants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/listmerchants","routeSlug":"/api/merchants/listmerchants","metadata":{"seo":{"title":"List Merchants","description":"Retrieve a list of Merchant resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMerchants","name":"List Merchants","isWebhook":false,"pointer":"/paths/~1merchants/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Merchants","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"country","in":"query","schemaId":"schema_80","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ISO 3166 alpha-3)."},"children":[]}]}]}]},{"name":"currency","in":"query","schemaId":"schema_81","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currencies"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ISO 4217)."},"children":[]}]}]}]},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"identity_business_name","in":"query","schemaId":"schema_82","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exact match)."},"children":[]}]}]}]},{"name":"identity_business_name.like","in":"query","schemaId":"schema_83","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (partial match)."},"children":[]}]}]}]},{"name":"identity_doing_business_as","in":"query","schemaId":"schema_82","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doing_business_as"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exact match)."},"children":[]}]}]}]},{"name":"identity_doing_business_as.like","in":"query","schemaId":"schema_83","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"doing_business_as"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (partial match)."},"children":[]}]}]}]},{"name":"identity_first_name","in":"query","schemaId":"schema_84","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exact match)."},"children":[]}]}]}]},{"name":"identity_first_name.like","in":"query","schemaId":"schema_85","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (partial match)."},"children":[]}]}]}]},{"name":"identity_id","in":"query","schemaId":"schema_86","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"identity_last_name","in":"query","schemaId":"schema_87","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exact match)."},"children":[]}]}]}]},{"name":"identity_last_name.like","in":"query","schemaId":"schema_88","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (partial match)."},"children":[]}]}]}]},{"name":"identity_role","in":"query","schemaId":"schema_89","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity_roles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"mcc","in":"query","schemaId":"schema_90","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mcc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"merchant_name","in":"query","schemaId":"schema_82","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exact match)."},"children":[]}]}]}]},{"name":"merchant_name.like","in":"query","schemaId":"schema_83","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (partial match)."},"children":[]}]}]}]},{"name":"processing_enabled","in":"query","schemaId":"schema_34","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by whether the Merchant's processing is enabled ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processing_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"processor_type","in":"query","schemaId":"schema_91","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"settlement_enabled","in":"query","schemaId":"schema_34","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by whether the Merchant's settlements are enabled ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"verification_id","in":"query","schemaId":"schema_92","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1merchants/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1merchants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchants","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"},{"name":"country","in":"query","example":"USA","schemaId":"schema_80"},{"name":"currency","in":"query","example":"USD","schemaId":"schema_81"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"id","in":"query","schemaId":"schema_6"},{"name":"identity_business_name","in":"query","example":"finix%20flowers","schemaId":"schema_82"},{"name":"identity_business_name.like","in":"query","example":"finix","schemaId":"schema_83"},{"name":"identity_doing_business_as","in":"query","example":"finix%20flowers","schemaId":"schema_82"},{"name":"identity_doing_business_as.like","in":"query","example":"finix","schemaId":"schema_83"},{"name":"identity_first_name","in":"query","example":"jonathan","schemaId":"schema_84"},{"name":"identity_first_name.like","in":"query","example":"jon","schemaId":"schema_85"},{"name":"identity_id","in":"query","example":"ID6ZC4KedcaCwECQcWr7SM4m","schemaId":"schema_86"},{"name":"identity_last_name","in":"query","example":"williams","schemaId":"schema_87"},{"name":"identity_last_name.like","in":"query","example":"will","schemaId":"schema_88"},{"name":"identity_role","in":"query","example":"SELLER","schemaId":"schema_89"},{"name":"mcc","in":"query","example":4900,"schemaId":"schema_90"},{"name":"merchant_name","in":"query","example":"finix%20flowers","schemaId":"schema_82"},{"name":"merchant_name.like","in":"query","example":"finix","schemaId":"schema_83"},{"name":"processing_enabled","in":"query","example":true,"schemaId":"schema_34"},{"name":"processor_type","in":"query","example":"DUMMY_V1","schemaId":"schema_91"},{"name":"settlement_enabled","in":"query","example":true,"schemaId":"schema_34"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"verification_id","in":"query","example":"VI7jopNSiaVMXWKkhxt6dJm7","schemaId":"schema_92"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/merchants","href":"merchants/listmerchants","openApiOperationId":"listMerchants","summary":"List Merchants"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/merchants\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"]}},"schemaId":"schema_78","exampleIds":["paths/~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1merchants/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_78","exampleIds":["paths/~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_78","exampleIds":["paths/~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/listmerchants"}],"panels":[]}]},"httpPath":"/merchants"},{"label":"Fetch a Merchant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/getmerchant","routeSlug":"/api/merchants/getmerchant","metadata":{"seo":{"title":"Fetch a Merchant","description":"Retrieve the details of a Merchant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMerchant","name":"Fetch a Merchant","isWebhook":false,"pointer":"/paths/~1merchants~1{merchant_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Merchant","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":"text","inline":true,"attributes":{"content":"Retrieve the details of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchant_id","in":"path","schemaId":"schema_93","description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4"}],"pointer":"/paths/~1merchants~1{merchant_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1merchants~1{merchant_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchants/{merchant_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"merchant_id","in":"path","required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4","schemaId":"schema_93"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/merchants/{merchant_id}","href":"merchants/getmerchant","openApiOperationId":"getMerchant","summary":"Fetch a Merchant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchant","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/200/content/application~1json/examples/Merchant"]}},"schemaId":"components/schemas/merchant","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/200/content/application~1json/examples/Merchant"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1merchants~1{merchant_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/merchant","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/200/content/application~1json/examples/Merchant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchant","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/200/content/application~1json/examples/Merchant"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/getmerchant"}],"panels":[]}]},"httpPath":"/merchants/{merchant_id}"},{"label":"Update a Merchant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/updatemerchant","routeSlug":"/api/merchants/updatemerchant","metadata":{"seo":{"title":"Update a Merchant","description":"Update a Merchant to:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateMerchant","name":"Update a Merchant","isWebhook":false,"pointer":"/paths/~1merchants~1{merchant_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Merchant","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":"text","inline":true,"attributes":{"content":"Update a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to:"},"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":"Change the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" information saved with the underlying processor"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/level-2-level-3-processing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Level 2/3 processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable partial authorizations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so the seller can't create new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorizations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be approved."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use the Settlement Queue"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Terminate a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for suspected fraud, compliance violations, excessive chargebacks, or merchant churn."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchant_id","in":"path","schemaId":"schema_93","description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4"}],"pointer":"/paths/~1merchants~1{merchant_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_94","exampleIds":["paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Terminate Merchant"]}},"schemaId":"schema_94","exampleIds":["paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Terminate Merchant"],"pointer":"/paths/~1merchants~1{merchant_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/merchants/{merchant_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"merchant_id","in":"path","required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4","schemaId":"schema_93"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_94","exampleIds":["paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Terminate Merchant"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/merchants/{merchant_id}","href":"merchants/updatemerchant","openApiOperationId":"updateMerchant","summary":"Update a Merchant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_94","exampleIds":["paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Terminate Merchant"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_94","exampleIds":["paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Terminate Merchant"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchant","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Terminate Merchant"]}},"schemaId":"components/schemas/merchant","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Terminate Merchant"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1merchants~1{merchant_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/merchant","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Terminate Merchant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchant","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Processing","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Settlements","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Buyer Charges","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Level 2~13 Processing","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Loan Repayment","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Partial Authorizations","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Settlement Queue","paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Terminate Merchant"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/updatemerchant"}],"panels":[]}]},"httpPath":"/merchants/{merchant_id}"},{"label":"Verify a Merchant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/merchants/createmerchantverification","routeSlug":"/api/merchants/createmerchantverification","metadata":{"seo":{"title":"Verify a Merchant","description":"Create a Verification on a Merchant to get them Approved. This request will create a new PENDING Verification. Listen to updates and re-fetch the Verification when it is SUCCEEDED or FAILED."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMerchantVerification","name":"Verify a Merchant","isWebhook":false,"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify a Merchant","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a Merchant to get them Approved. This request will create a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verification. Listen to updates and re-fetch the Verification when it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"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":"For handling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Verifications, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/verifications/getverification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fetch a Verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See also "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-process"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding Process"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Seller Merchants and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/recipient-verification-process"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verification Requirements for Payouts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Recipient Merchants."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchant_id","in":"path","schemaId":"schema_93","description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4"}],"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_95","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/requestBody/content/application~1json/examples/Verify a Merchant"]}},"schemaId":"schema_95","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/requestBody/content/application~1json/examples/Verify a Merchant"],"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/merchants/{merchant_id}/verifications","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"merchant_id","in":"path","required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4","schemaId":"schema_93"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_95","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/requestBody/content/application~1json/examples/Verify a Merchant"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/merchants/{merchant_id}/verifications","href":"merchants/createmerchantverification","openApiOperationId":"createMerchantVerification","summary":"Verify a Merchant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_95","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/requestBody/content/application~1json/examples/Verify a Merchant"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_95","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/requestBody/content/application~1json/examples/Verify a Merchant"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A Merchant Verification","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchant_verification","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/201/content/application~1json/examples/Pending Merchant Verification"]}},"schemaId":"components/schemas/merchant_verification","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/201/content/application~1json/examples/Pending Merchant Verification"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/merchant_verification","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/201/content/application~1json/examples/Pending Merchant Verification"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/merchant_verification","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/201/content/application~1json/examples/Pending Merchant Verification"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchants/createmerchantverification"}],"panels":[]}]},"httpPath":"/merchants/{merchant_id}/verifications"}],"content":{"contentType":"group","meta":{"name":"Merchants"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchants","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents the entity's merchant account on a processor. Your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process payments."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/getting-started"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding Sellers"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/identities/{identity_id}/merchants","summary":"Create a Merchant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchants/createmerchant","deprecated":false},{"title":"/merchants","summary":"List Merchants","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchants/listmerchants","deprecated":false},{"title":"/merchants/{merchant_id}","summary":"Fetch a Merchant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchants/getmerchant","deprecated":false},{"title":"/merchants/{merchant_id}","summary":"Update a Merchant","prefix":{"name":"put","color":"put"},"badges":[],"link":"/merchants/updatemerchant","deprecated":false},{"title":"/merchants/{merchant_id}/verifications","summary":"Verify a Merchant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchants/createmerchantverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Microdeposits","link":"/api/microdeposits","routeSlug":"/api/microdeposits","items":[{"label":"List Microdeposits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/microdeposits/listmicrodeposits","routeSlug":"/api/microdeposits/listmicrodeposits","metadata":{"seo":{"title":"List Microdeposits","description":"Retrieve a list of Microdeposit resources. Filter by payment_instrument_id to find microdeposits for a specific Payment Instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMicroDeposits","name":"List Microdeposits","isWebhook":false,"pointer":"/paths/~1microdeposits/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Microdeposits","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":"text","inline":true,"attributes":{"content":"Retrieve a list of Microdeposit resources. Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_instrument_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find microdeposits for a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"payment_instrument_id","in":"query","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]}],"pointer":"/paths/~1microdeposits/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1microdeposits/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/microdeposits","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"payment_instrument_id","in":"query","example":"PIcgYZswyRfqSSbvMsxuaHxZ","schemaId":"schema_96"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/microdeposits","href":"microdeposits/listmicrodeposits","openApiOperationId":"listMicroDeposits","summary":"List Microdeposits"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/microdeposits\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Microdeposit resources","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_97","exampleIds":["paths/~1microdeposits/get/responses/200/content/application~1json/examples/List of Microdeposits"]}},"schemaId":"schema_97","exampleIds":["paths/~1microdeposits/get/responses/200/content/application~1json/examples/List of Microdeposits"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1microdeposits/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_97","exampleIds":["paths/~1microdeposits/get/responses/200/content/application~1json/examples/List of Microdeposits"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_97","exampleIds":["paths/~1microdeposits/get/responses/200/content/application~1json/examples/List of Microdeposits"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/microdeposits/listmicrodeposits"}],"panels":[]}]},"httpPath":"/microdeposits"},{"label":"Fetch a Microdeposit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/microdeposits/getmicrodeposit","routeSlug":"/api/microdeposits/getmicrodeposit","metadata":{"seo":{"title":"Fetch a Microdeposit","description":"Retrieve the details of a Microdeposit to check the verification's status, remaining submission tries, and expiration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMicroDeposit","name":"Fetch a Microdeposit","isWebhook":false,"pointer":"/paths/~1microdeposits~1{microdeposit_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Microdeposit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the details of a Microdeposit to check the verification's status, remaining submission tries, and expiration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"microdeposit_id","in":"path","schemaId":"schema_98","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"microdeposit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"microdeposit_4ek6YXRKJ1fqvs5E4oHNcY"}],"pointer":"/paths/~1microdeposits~1{microdeposit_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1microdeposits~1{microdeposit_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/microdeposits/{microdeposit_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"microdeposit_id","in":"path","required":true,"example":"microdeposit_4ek6YXRKJ1fqvs5E4oHNcY","schemaId":"schema_98"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/microdeposits/{microdeposit_id}","href":"microdeposits/getmicrodeposit","openApiOperationId":"getMicroDeposit","summary":"Fetch a Microdeposit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A single Microdeposit","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/microdeposit","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Pending verification","paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Verified"]}},"schemaId":"components/schemas/microdeposit","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Pending verification","paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Verified"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1microdeposits~1{microdeposit_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/microdeposit","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Pending verification","paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Verified"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/microdeposit","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Pending verification","paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Verified"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1microdeposits~1{microdeposit_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/microdeposits/getmicrodeposit"}],"panels":[]}]},"httpPath":"/microdeposits/{microdeposit_id}"}],"content":{"contentType":"group","meta":{"name":"Microdeposits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Microdeposits","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":"A Microdeposit represents the $0.01 verification deposit Finix sends to a bank account when microdeposit verification is required. The deposit's statement descriptor carries the code the account owner submits to verify the bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You may check a verification's status, remaining submission tries, and expiration. The verification code is never returned by the API. The account owner must read it from their bank statement."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/microdeposit-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Microdeposit verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/microdeposits","summary":"List Microdeposits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/microdeposits/listmicrodeposits","deprecated":false},{"title":"/microdeposits/{microdeposit_id}","summary":"Fetch a Microdeposit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/microdeposits/getmicrodeposit","deprecated":false}]}]}]}]}},{"type":"group","label":"Onboarding Forms","link":"/api/onboarding-forms","routeSlug":"/api/onboarding-forms","items":[{"label":"Create an Onboarding Form","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/onboarding-forms/createonboardingform","routeSlug":"/api/onboarding-forms/createonboardingform","metadata":{"seo":{"title":"Create an Onboarding Form","description":"Create an Onboarding Form by entering the processor’s name you want to onboard users to. Also, provide the links to send users after they finish or leave the form."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOnboardingForm","name":"Create an Onboarding Form","isWebhook":false,"pointer":"/paths/~1onboarding_forms/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Onboarding Form","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":"text","inline":true,"attributes":{"content":"Create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Onboarding Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by entering the processor’s name you want to onboard users to. Also, provide the links to send users after they finish or leave the form."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Onboarding Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1onboarding_forms/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_99","exampleIds":["paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - All Fields"]}},"schemaId":"schema_99","exampleIds":["paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - All Fields"],"pointer":"/paths/~1onboarding_forms/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/onboarding_forms","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_99","exampleIds":["paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - All Fields"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/onboarding_forms","href":"onboarding-forms/createonboardingform","openApiOperationId":"createOnboardingForm","summary":"Create an Onboarding Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_99","exampleIds":["paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - All Fields"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_99","exampleIds":["paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - All Fields"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Onboarding Form","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/onboarding_form","exampleIds":["paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - All Fields"]}},"schemaId":"components/schemas/onboarding_form","exampleIds":["paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - All Fields"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1onboarding_forms/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/onboarding_form","exampleIds":["paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - All Fields"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/onboarding_form","exampleIds":["paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - Minimal Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - All Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields","paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - All Fields"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/onboarding-forms/createonboardingform"}],"panels":[]}]},"httpPath":"/onboarding_forms"},{"label":"Fetch an Onboarding Form","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/onboarding-forms/getonboardingform","routeSlug":"/api/onboarding-forms/getonboardingform","metadata":{"seo":{"title":"Fetch an Onboarding Form","description":"Retrieve the details of an existing Onboarding Form."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOnboardingForm","name":"Fetch an Onboarding Form","isWebhook":false,"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch an Onboarding Form","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Onboarding Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"onboarding_form_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The id of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onboarding_form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"obf_4fDUAgocch7q6m4JyzW1HS"}],"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/onboarding_forms/{onboarding_form_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"onboarding_form_id","in":"path","required":true,"example":"obf_4fDUAgocch7q6m4JyzW1HS","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/onboarding_forms/{onboarding_form_id}","href":"onboarding-forms/getonboardingform","openApiOperationId":"getOnboardingForm","summary":"Fetch an Onboarding Form"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Onboarding Form"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/onboarding_form","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/200/content/application~1json/examples/Onboarding Form"]}},"schemaId":"components/schemas/onboarding_form","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/200/content/application~1json/examples/Onboarding Form"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/onboarding_form","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/200/content/application~1json/examples/Onboarding Form"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/onboarding_form","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/200/content/application~1json/examples/Onboarding Form"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/onboarding-forms/getonboardingform"}],"panels":[]}]},"httpPath":"/onboarding_forms/{onboarding_form_id}"},{"label":"Create an Onboarding Form Link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/onboarding-forms/createonboardingformlink","routeSlug":"/api/onboarding-forms/createonboardingformlink","metadata":{"seo":{"title":"Create an Onboarding Form Link","description":"Create a link that lets users resume their Onboarding Form."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOnboardingFormLink","name":"Create an Onboarding Form Link","isWebhook":false,"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}~1links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Onboarding Form Link","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":"text","inline":true,"attributes":{"content":"Create a link that lets users resume their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Onboarding Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"onboarding_form_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onboarding_form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"required":true,"example":"obf_4fDUAgocch7q6m4JyzW1HS"}],"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createOnboardingLink","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/requestBody/content/application~1json/examples/Onboarding Form Link"]}},"schemaId":"components/schemas/createOnboardingLink","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/requestBody/content/application~1json/examples/Onboarding Form Link"],"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/onboarding_forms/{onboarding_form_id}/links","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"onboarding_form_id","in":"path","required":true,"example":"obf_4fDUAgocch7q6m4JyzW1HS","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createOnboardingLink","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/requestBody/content/application~1json/examples/Onboarding Form Link"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/onboarding_forms/{onboarding_form_id}/links","href":"onboarding-forms/createonboardingformlink","openApiOperationId":"createOnboardingFormLink","summary":"Create an Onboarding Form Link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createOnboardingLink","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/requestBody/content/application~1json/examples/Onboarding Form Link"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createOnboardingLink","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/requestBody/content/application~1json/examples/Onboarding Form Link"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Onboarding Link","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/onboarding_link","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/201/content/application~1json/examples/Onboarding Link"]}},"schemaId":"components/schemas/onboarding_link","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/201/content/application~1json/examples/Onboarding Link"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/onboarding_link","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/201/content/application~1json/examples/Onboarding Link"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/onboarding_link","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/201/content/application~1json/examples/Onboarding Link"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/onboarding-forms/createonboardingformlink"}],"panels":[]}]},"httpPath":"/onboarding_forms/{onboarding_form_id}/links"}],"content":{"contentType":"group","meta":{"name":"Onboarding Forms"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Onboarding Forms","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":"Finix offers and hosts pre-built onboarding forms that you can use to collect onboarding and identity verification information from your users."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-via-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding via the API"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/onboarding_forms","summary":"Create an Onboarding Form","prefix":{"name":"post","color":"post"},"badges":[],"link":"/onboarding-forms/createonboardingform","deprecated":false},{"title":"/onboarding_forms/{onboarding_form_id}","summary":"Fetch an Onboarding Form","prefix":{"name":"get","color":"get"},"badges":[],"link":"/onboarding-forms/getonboardingform","deprecated":false},{"title":"/onboarding_forms/{onboarding_form_id}/links","summary":"Create an Onboarding Form Link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/onboarding-forms/createonboardingformlink","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Instruments","link":"/api/payment-instruments","routeSlug":"/api/payment-instruments","items":[{"label":"Create a Payment Instrument","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/createpaymentinstrument","routeSlug":"/api/payment-instruments/createpaymentinstrument","metadata":{"seo":{"title":"Create a Payment Instrument","description":"Create a Payment Instrument resource using a card or bank account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentInstrument","name":"Create a Payment Instrument","isWebhook":false,"pointer":"/paths/~1payment_instruments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Payment Instrument","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource using a card or bank account."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"Payment Instruments PCI Scope"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The creation of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" directly via Finix's API should only be done for testing purposes. You must use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-tokenization/tokenization-forms"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our hosted fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the javascript client to remain out of PCI scope."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instruments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_100","exampleIds":["paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"]}},"schemaId":"schema_100","exampleIds":["paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"],"pointer":"/paths/~1payment_instruments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment_instruments","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_100","exampleIds":["paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"]}},"responseCodes":["201","400","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instruments","href":"payment-instruments/createpaymentinstrument","openApiOperationId":"createPaymentInstrument","summary":"Create a Payment Instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_100","exampleIds":["paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_100","exampleIds":["paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Payment Instrument","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101","exampleIds":["paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Pending Verification","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Verified","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"]}},"schemaId":"schema_101","exampleIds":["paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Pending Verification","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Verified","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/422/content/application~1json/examples/Identity not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/422/content/application~1json/examples/Identity not found"]}],"pointer":"/paths/~1payment_instruments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_101","exampleIds":["paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Pending Verification","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Verified","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_101","exampleIds":["paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Pending Verification","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Verified","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Plaid Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Canadian Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Bank Account","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Card","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough","paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/422/content/application~1json/examples/Identity not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/post/responses/422/content/application~1json/examples/Identity not found"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/createpaymentinstrument"}],"panels":[]}]},"httpPath":"/payment_instruments"},{"label":"List Payment Instruments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/listpaymentinstruments","routeSlug":"/api/payment-instruments/listpaymentinstruments","metadata":{"seo":{"title":"List Payment Instruments","description":"Retrieve a list of Payment Instrument resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentInstruments","name":"List Payment Instruments","isWebhook":false,"pointer":"/paths/~1payment_instruments/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Payment Instruments","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no query parameters are specified in the request the API automatically limits the response to records from the last 30 days. You can request older data by passing an explicit created_at.lte filter."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"account_last4","in":"query","schemaId":"schema_102","description":"Filter by the last 4 digits of the account if available."},{"name":"account_routing_number","in":"query","schemaId":"schema_103","description":"Filter by the account routing number if available."},{"name":"bin","in":"query","schemaId":"schema_104","description":"Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"expiration_month","in":"query","schemaId":"schema_105","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the expiration month associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if applicable. This filter only applies to payment cards."},"children":[]}]}]}]},{"name":"expiration_year","in":"query","schemaId":"schema_106","description":"Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards."},{"name":"id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"last4","in":"query","schemaId":"schema_107","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the last 4 digits of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" card. This filter only applies to payment cards."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"name","in":"query","schemaId":"schema_6","description":"Filter by the name."},{"name":"owner_identity_id","in":"query","schemaId":"schema_108","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the owner id of the associated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_109","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}]},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instruments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instruments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment_instruments","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"account_last4","in":"query","required":false,"example":"4242","schemaId":"schema_102"},{"name":"account_routing_number","in":"query","required":false,"example":"9444","schemaId":"schema_103"},{"name":"bin","in":"query","required":false,"example":"411111","schemaId":"schema_104"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"expiration_month","in":"query","required":false,"example":"9","schemaId":"schema_105"},{"name":"expiration_year","in":"query","required":false,"example":"2029","schemaId":"schema_106"},{"name":"id","in":"query","schemaId":"schema_6"},{"name":"last4","in":"query","required":false,"example":"0454","schemaId":"schema_107"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"name","in":"query","required":false,"schemaId":"schema_6"},{"name":"owner_identity_id","in":"query","required":false,"example":"IDcWwprrKrD6cSh225JWPri3","schemaId":"schema_108"},{"name":"type","in":"query","required":false,"example":"BANK_ACCOUNT","schemaId":"schema_109"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instruments","href":"payment-instruments/listpaymentinstruments","openApiOperationId":"listPaymentInstruments","summary":"List Payment Instruments"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/payment_instruments\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_110","exampleIds":["paths/~1payment_instruments/get/responses/200/content/application~1json/examples/List of Payment Instruments"]}},"schemaId":"schema_110","exampleIds":["paths/~1payment_instruments/get/responses/200/content/application~1json/examples/List of Payment Instruments"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1payment_instruments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_110","exampleIds":["paths/~1payment_instruments/get/responses/200/content/application~1json/examples/List of Payment Instruments"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_110","exampleIds":["paths/~1payment_instruments/get/responses/200/content/application~1json/examples/List of Payment Instruments"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/listpaymentinstruments"}],"panels":[]}]},"httpPath":"/payment_instruments"},{"label":"Fetch a Payment Instrument","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/getpaymentinstrument","routeSlug":"/api/payment-instruments/getpaymentinstrument","metadata":{"seo":{"title":"Fetch a Payment Instrument","description":"Retrieve the details of an existing Payment Instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentInstrument","name":"Fetch a Payment Instrument","isWebhook":false,"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Payment Instrument","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_instrument_id","in":"path","schemaId":"schema_111","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"PInVUXZLswZi6pdcK1T41MuE"}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment_instruments/{payment_instrument_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"payment_instrument_id","in":"path","required":true,"example":"PInVUXZLswZi6pdcK1T41MuE","schemaId":"schema_111"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instruments/{payment_instrument_id}","href":"payment-instruments/getpaymentinstrument","openApiOperationId":"getPaymentInstrument","summary":"Fetch a Payment Instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/200/content/application~1json/examples/Payment Instrument"]}},"schemaId":"schema_112","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/200/content/application~1json/examples/Payment Instrument"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_112","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/200/content/application~1json/examples/Payment Instrument"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_112","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/200/content/application~1json/examples/Payment Instrument"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/getpaymentinstrument"}],"panels":[]}]},"httpPath":"/payment_instruments/{payment_instrument_id}"},{"label":"Update a Payment Instrument","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/updatepaymentinstrument","routeSlug":"/api/payment-instruments/updatepaymentinstrument","metadata":{"seo":{"title":"Update a Payment Instrument","description":"Update a Payment Instrument to:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePaymentInstrument","name":"Update a Payment Instrument","isWebhook":false,"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Payment Instrument","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":"text","inline":true,"attributes":{"content":"Update a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to:"},"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":"Change the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing address"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in case the account holder moved ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrument_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource so it can't be used in requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"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":"Change the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"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":"Enable or disable "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Updater"},"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":"Enable or disable "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network Tokens"},"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":"Update the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"expiration date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrument_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/microdeposit-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Microdeposit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" code ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"instrument_type: BANK_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only)."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_instrument_id","in":"path","schemaId":"schema_111","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"PInVUXZLswZi6pdcK1T41MuE"}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Verify Microdeposits"]}},"schemaId":"schema_113","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Verify Microdeposits"],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payment_instruments/{payment_instrument_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"payment_instrument_id","in":"path","required":true,"example":"PInVUXZLswZi6pdcK1T41MuE","schemaId":"schema_111"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_113","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Verify Microdeposits"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instruments/{payment_instrument_id}","href":"payment-instruments/updatepaymentinstrument","openApiOperationId":"updatePaymentInstrument","summary":"Update a Payment Instrument"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_113","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Verify Microdeposits"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_113","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Verify Microdeposits"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Verify Microdeposits"]}},"schemaId":"schema_114","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Verify Microdeposits"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_114","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Verify Microdeposits"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_114","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Account Updater","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Network Tokens","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Card Address","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Name","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update and Verify Name","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Tags","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Expiration Date","paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Verify Microdeposits"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/updatepaymentinstrument"}],"panels":[]}]},"httpPath":"/payment_instruments/{payment_instrument_id}"},{"label":"List Instrument History Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/listinstrumenthistoryentries","routeSlug":"/api/payment-instruments/listinstrumenthistoryentries","metadata":{"seo":{"title":"List Instrument History Entries","description":"Whenever a stored payment card's details are updated, an Instrument History Entry is created. Use this endpoint to retrieve a list of Instrument History Entries for a specific Payment Instrument."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInstrumentHistoryEntries","name":"List Instrument History Entries","isWebhook":false,"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Instrument History Entries","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":"text","inline":true,"attributes":{"content":"Whenever a stored payment card's details are updated, an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created. Use this endpoint to retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_instrument_id","in":"path","schemaId":"schema_6","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that triggered the creation of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"PInVUXZLswZi6pdcK1T41MuE"}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment_instruments/{payment_instrument_id}/instrument_history","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"payment_instrument_id","in":"path","required":true,"example":"PInVUXZLswZi6pdcK1T41MuE","schemaId":"schema_6"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instruments/{payment_instrument_id}/instrument_history","href":"payment-instruments/listinstrumenthistoryentries","openApiOperationId":"listInstrumentHistoryEntries","summary":"List Instrument History Entries"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl -i -X GET \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \\\n  'https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history' \\\n  -H 'Finix-Version: 2022-02-01'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/200/content/application~1json/examples/List of Instrument History Entries"]}},"schemaId":"schema_115","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/200/content/application~1json/examples/List of Instrument History Entries"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_115","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/200/content/application~1json/examples/List of Instrument History Entries"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_115","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/200/content/application~1json/examples/List of Instrument History Entries"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/listinstrumenthistoryentries"}],"panels":[]}]},"httpPath":"/payment_instruments/{payment_instrument_id}/instrument_history"},{"label":"Verify CVV, AVS, and Name","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/createpaymentinstrumentverification","routeSlug":"/api/payment-instruments/createpaymentinstrumentverification","metadata":{"seo":{"title":"Verify CVV, AVS, and Name","description":"Verify a Payment Instrument to determine CVV, AVS, and name verification results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentInstrumentVerification","name":"Verify CVV, AVS, and Name","isWebhook":false,"pointer":"/paths/~1payment_instruments~1{payment_instrument_id_verify}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify CVV, AVS, and Name","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":"text","inline":true,"attributes":{"content":"Verify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine CVV, AVS, and name verification results."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"warning","name":"PCI Scope Restriction"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CVV submission is only available to PCI-compliant merchants. Non-PCI customers should not collect and pass CVV in this request."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_instrument_id_verify","in":"path","schemaId":"schema_111","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you wish to verify."},"children":[]}]}]}],"required":true,"example":"PIn8as75qLQFqQ7G4NdBUk58"}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id_verify}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_116","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Name Verification"]}},"schemaId":"schema_116","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Name Verification"],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payment_instruments/{payment_instrument_id_verify}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"payment_instrument_id_verify","in":"path","required":true,"example":"PIn8as75qLQFqQ7G4NdBUk58","schemaId":"schema_111"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_116","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Name Verification"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instruments/{payment_instrument_id_verify}","href":"payment-instruments/createpaymentinstrumentverification","openApiOperationId":"createPaymentInstrumentVerification","summary":"Verify CVV, AVS, and Name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_116","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Name Verification"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_116","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Name Verification"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A single Payment Instrument.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_card","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Name Verification"]}},"schemaId":"components/schemas/payment_instrument_card","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Name Verification"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payment_instrument_card","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Name Verification"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_card","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/CVV Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Address Verification","paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Name Verification"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/createpaymentinstrumentverification"}],"panels":[]}]},"httpPath":"/payment_instruments/{payment_instrument_id_verify}"},{"label":"Verify Push-to-Card Eligibility","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/createpaymentinstrumentverificationpushtocard","routeSlug":"/api/payment-instruments/createpaymentinstrumentverificationpushtocard","metadata":{"seo":{"title":"Verify Push-to-Card Eligibility","description":"Determine Push To Card eligibility for Push To Card customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentInstrumentVerificationPushToCard","name":"Verify Push-to-Card Eligibility","isWebhook":false,"pointer":"/paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verify Push-to-Card Eligibility","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":"text","inline":true,"attributes":{"content":"Determine Push To Card eligibility for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/card-payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push To Card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, the cardholder's name is verified with the issuing bank, and the result is shown in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name_verification_results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This applies to Visa and Mastercard."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_instrument_id_verify","in":"path","schemaId":"schema_111","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you wish to verify."},"children":[]}]}]}],"required":true,"example":"PIn8as75qLQFqQ7G4NdBUk58"}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createPaymentInstrumentVerificationPushToCard","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/requestBody/content/application~1json/examples/Verify Push-to-Card Eligibility"]}},"schemaId":"components/schemas/createPaymentInstrumentVerificationPushToCard","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/requestBody/content/application~1json/examples/Verify Push-to-Card Eligibility"],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment_instruments/{payment_instrument_id_verify}/verifications","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"payment_instrument_id_verify","in":"path","required":true,"example":"PIn8as75qLQFqQ7G4NdBUk58","schemaId":"schema_111"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createPaymentInstrumentVerificationPushToCard","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/requestBody/content/application~1json/examples/Verify Push-to-Card Eligibility"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instruments/{payment_instrument_id_verify}/verifications","href":"payment-instruments/createpaymentinstrumentverificationpushtocard","openApiOperationId":"createPaymentInstrumentVerificationPushToCard","summary":"Verify Push-to-Card Eligibility"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createPaymentInstrumentVerificationPushToCard","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/requestBody/content/application~1json/examples/Verify Push-to-Card Eligibility"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createPaymentInstrumentVerificationPushToCard","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/requestBody/content/application~1json/examples/Verify Push-to-Card Eligibility"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_verification","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/200/content/application~1json/examples/Verify Push-to-Card Eligibility"]}},"schemaId":"components/schemas/payment_instrument_verification","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/200/content/application~1json/examples/Verify Push-to-Card Eligibility"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payment_instrument_verification","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/200/content/application~1json/examples/Verify Push-to-Card Eligibility"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_verification","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/200/content/application~1json/examples/Verify Push-to-Card Eligibility"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/createpaymentinstrumentverificationpushtocard"}],"panels":[]}]},"httpPath":"/payment_instruments/{payment_instrument_id_verify}/verifications"},{"label":"Create an Apple Pay Session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instruments/createapplepaysession","routeSlug":"/api/payment-instruments/createapplepaysession","metadata":{"seo":{"title":"Create an Apple Pay Session","description":"Create an apple_pay_session to process Apple Pay transactions on the web."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createApplePaySession","name":"Create an Apple Pay Session","isWebhook":false,"pointer":"/paths/~1apple_pay_sessions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an Apple Pay 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":"text","inline":true,"attributes":{"content":"Create an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apple_pay_session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process Apple Pay transactions on the web."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create an Apple Pay Session, pass the unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"validation_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (provided by Apple) while creating an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apple_pay_sessions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. Finix returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchantSession"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object that you can use to create a payment. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/digital-wallets/apple-pay"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apple Pay"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1apple_pay_sessions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createApplePaySession","exampleIds":["paths/~1apple_pay_sessions/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay Session"]}},"schemaId":"components/schemas/createApplePaySession","exampleIds":["paths/~1apple_pay_sessions/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay Session"],"pointer":"/paths/~1apple_pay_sessions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/apple_pay_sessions","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createApplePaySession","exampleIds":["paths/~1apple_pay_sessions/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay Session"]}},"responseCodes":["201","400","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/apple_pay_sessions","href":"payment-instruments/createapplepaysession","openApiOperationId":"createApplePaySession","summary":"Create an Apple Pay Session"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createApplePaySession","exampleIds":["paths/~1apple_pay_sessions/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay Session"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createApplePaySession","exampleIds":["paths/~1apple_pay_sessions/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay Session"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Apple Pay Session","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_apple_pay_session","exampleIds":["paths/~1apple_pay_sessions/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay Session"]}},"schemaId":"components/schemas/payment_instrument_apple_pay_session","exampleIds":["paths/~1apple_pay_sessions/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay Session"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/422/content/application~1json/examples/Domain not registered for Merchant"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/422/content/application~1json/examples/Domain not registered for Merchant"]}],"pointer":"/paths/~1apple_pay_sessions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/payment_instrument_apple_pay_session","exampleIds":["paths/~1apple_pay_sessions/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay Session"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_apple_pay_session","exampleIds":["paths/~1apple_pay_sessions/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay Session"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/422/content/application~1json/examples/Domain not registered for Merchant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1apple_pay_sessions/post/responses/422/content/application~1json/examples/Domain not registered for Merchant"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instruments/createapplepaysession"}],"panels":[]}]},"httpPath":"/apple_pay_sessions"}],"content":{"contentType":"group","meta":{"name":"Payment Instruments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Instruments","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents the payment details of a credit card or bank account. Payment details get tokenized multiple times and each tokenization produces a unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is associated with a single "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Identities"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" it's associated with can't be changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Including an address when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can lower interchange on credit card 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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-tokenization/tokenization-forms"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using Hosted Fields"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/getting-started"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Getting Started"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment_instruments","summary":"Create a Payment Instrument","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/createpaymentinstrument","deprecated":false},{"title":"/payment_instruments","summary":"List Payment Instruments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instruments/listpaymentinstruments","deprecated":false},{"title":"/payment_instruments/{payment_instrument_id}","summary":"Fetch a Payment Instrument","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instruments/getpaymentinstrument","deprecated":false},{"title":"/payment_instruments/{payment_instrument_id}","summary":"Update a Payment Instrument","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-instruments/updatepaymentinstrument","deprecated":false},{"title":"/payment_instruments/{payment_instrument_id}/instrument_history","summary":"List Instrument History Entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instruments/listinstrumenthistoryentries","deprecated":false},{"title":"/payment_instruments/{payment_instrument_id_verify}","summary":"Verify CVV, AVS, and Name","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-instruments/createpaymentinstrumentverification","deprecated":false},{"title":"/payment_instruments/{payment_instrument_id_verify}/verifications","summary":"Verify Push-to-Card Eligibility","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/createpaymentinstrumentverificationpushtocard","deprecated":false},{"title":"/apple_pay_sessions","summary":"Create an Apple Pay Session","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instruments/createapplepaysession","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Instrument Associations","link":"/api/payment-instrument-associations","routeSlug":"/api/payment-instrument-associations","items":[{"label":"Create a Payment Instrument Association","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instrument-associations/createpaymentinstrumentassociation","routeSlug":"/api/payment-instrument-associations/createpaymentinstrumentassociation","metadata":{"seo":{"title":"Create a Payment Instrument Association","description":"Create a Payment Instrument Association to associate a Payment Instrument with a Merchant for fee assignment purposes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentInstrumentAssociation","name":"Create a Payment Instrument Association","isWebhook":false,"pointer":"/paths/~1payment_instrument_associations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Payment Instrument Association","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to associate a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for fee assignment purposes."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instrument_associations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createPaymentInstrumentAssociation","exampleIds":["paths/~1payment_instrument_associations/post/requestBody/content/application~1json/examples/Payment Instrument Association"]}},"schemaId":"components/schemas/createPaymentInstrumentAssociation","exampleIds":["paths/~1payment_instrument_associations/post/requestBody/content/application~1json/examples/Payment Instrument Association"],"pointer":"/paths/~1payment_instrument_associations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payment_instrument_associations","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createPaymentInstrumentAssociation","exampleIds":["paths/~1payment_instrument_associations/post/requestBody/content/application~1json/examples/Payment Instrument Association"]}},"responseCodes":["201","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instrument_associations","href":"payment-instrument-associations/createpaymentinstrumentassociation","openApiOperationId":"createPaymentInstrumentAssociation","summary":"Create a Payment Instrument Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createPaymentInstrumentAssociation","exampleIds":["paths/~1payment_instrument_associations/post/requestBody/content/application~1json/examples/Payment Instrument Association"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createPaymentInstrumentAssociation","exampleIds":["paths/~1payment_instrument_associations/post/requestBody/content/application~1json/examples/Payment Instrument Association"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Payment Instrument Association","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations/post/responses/201/content/application~1json/examples/Payment Instrument Association"]}},"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations/post/responses/201/content/application~1json/examples/Payment Instrument Association"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1payment_instrument_associations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations/post/responses/201/content/application~1json/examples/Payment Instrument Association"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations/post/responses/201/content/application~1json/examples/Payment Instrument Association"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instrument-associations/createpaymentinstrumentassociation"}],"panels":[]}]},"httpPath":"/payment_instrument_associations"},{"label":"List Payment Instrument Associations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instrument-associations/listpaymentinstrumentassociations","routeSlug":"/api/payment-instrument-associations/listpaymentinstrumentassociations","metadata":{"seo":{"title":"List Payment Instrument Associations","description":"Retrieve a list of Payment Instrument Association resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentInstrumentAssociations","name":"List Payment Instrument Associations","isWebhook":false,"pointer":"/paths/~1payment_instrument_associations/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Payment Instrument Associations","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant_id","in":"query","schemaId":"schema_20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"payment_instrument_id","in":"query","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instrument_associations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instrument_associations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment_instrument_associations","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant_id","in":"query","example":"MUeDVrf2ahuKc9Eg5TeZugvs","schemaId":"schema_20"},{"name":"payment_instrument_id","in":"query","example":"PIcgYZswyRfqSSbvMsxuaHxZ","schemaId":"schema_96"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instrument_associations","href":"payment-instrument-associations/listpaymentinstrumentassociations","openApiOperationId":"listPaymentInstrumentAssociations","summary":"List Payment Instrument Associations"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/payment_instrument_associations\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117","exampleIds":["paths/~1payment_instrument_associations/get/responses/200/content/application~1json/examples/List of Payment Instrument Associations"]}},"schemaId":"schema_117","exampleIds":["paths/~1payment_instrument_associations/get/responses/200/content/application~1json/examples/List of Payment Instrument Associations"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1payment_instrument_associations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_117","exampleIds":["paths/~1payment_instrument_associations/get/responses/200/content/application~1json/examples/List of Payment Instrument Associations"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_117","exampleIds":["paths/~1payment_instrument_associations/get/responses/200/content/application~1json/examples/List of Payment Instrument Associations"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instrument-associations/listpaymentinstrumentassociations"}],"panels":[]}]},"httpPath":"/payment_instrument_associations"},{"label":"Fetch a Payment Instrument Association","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instrument-associations/getpaymentinstrumentassociation","routeSlug":"/api/payment-instrument-associations/getpaymentinstrumentassociation","metadata":{"seo":{"title":"Fetch a Payment Instrument Association","description":"Retrieve the details of an existing Payment Instrument Association."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentInstrumentAssociation","name":"Fetch a Payment Instrument Association","isWebhook":false,"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Payment Instrument Association","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_instrument_association_id","in":"path","schemaId":"schema_118","description":[{"$$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":"Payment Instrument Fee Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"payment_instrument_association_iCfFgdmmVF3koH1gqxmgdV"}],"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payment_instrument_associations/{payment_instrument_association_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"payment_instrument_association_id","in":"path","required":true,"example":"payment_instrument_association_iCfFgdmmVF3koH1gqxmgdV","schemaId":"schema_118"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instrument_associations/{payment_instrument_association_id}","href":"payment-instrument-associations/getpaymentinstrumentassociation","openApiOperationId":"getPaymentInstrumentAssociation","summary":"Fetch a Payment Instrument Association"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_iCfFgdmmVF3koH1gqxmgdV\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A single Payment Instrument Association","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/200/content/application~1json/examples/Payment Instrument Association"]}},"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/200/content/application~1json/examples/Payment Instrument Association"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/200/content/application~1json/examples/Payment Instrument Association"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/200/content/application~1json/examples/Payment Instrument Association"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instrument-associations/getpaymentinstrumentassociation"}],"panels":[]}]},"httpPath":"/payment_instrument_associations/{payment_instrument_association_id}"},{"label":"Update a Payment Instrument Association","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/payment-instrument-associations/updatepaymentinstrumentassociation","routeSlug":"/api/payment-instrument-associations/updatepaymentinstrumentassociation","metadata":{"seo":{"title":"Update a Payment Instrument Association","description":"Update the tags of an existing Payment Instrument Association."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePaymentInstrumentAssociation","name":"Update a Payment Instrument Association","isWebhook":false,"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Payment Instrument Association","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":"text","inline":true,"attributes":{"content":"Update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"payment_instrument_association_id","in":"path","schemaId":"schema_118","description":[{"$$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":"Payment Instrument Fee Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"payment_instrument_association_iCfFgdmmVF3koH1gqxmgdV"}],"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Disable"]}},"schemaId":"schema_119","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Disable"],"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payment_instrument_associations/{payment_instrument_association_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"payment_instrument_association_id","in":"path","required":true,"example":"payment_instrument_association_iCfFgdmmVF3koH1gqxmgdV","schemaId":"schema_118"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_119","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Disable"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/payment_instrument_associations/{payment_instrument_association_id}","href":"payment-instrument-associations/updatepaymentinstrumentassociation","openApiOperationId":"updatePaymentInstrumentAssociation","summary":"Update a Payment Instrument Association"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_119","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Disable"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_119","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Disable"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A single Payment Instrument Association","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Disable"]}},"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Disable"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Disable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/payment_instrument_association","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Tags","paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Disable"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-instrument-associations/updatepaymentinstrumentassociation"}],"panels":[]}]},"httpPath":"/payment_instrument_associations/{payment_instrument_association_id}"}],"content":{"contentType":"group","meta":{"name":"Payment Instrument Associations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Instrument Associations","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":"In Finix, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are tied to the owner of that account. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tied to buyer will be the cards used for purchases while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tied to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the bank accounts where they receive settlements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Therefore when billing events occur that are tied to a buyer's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. enrolling in account updater, using Plaid for tokenization, etc) Finix cannot automatically map those fees to a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". By default, these costs are instead charged to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. the Platform, Marketplace, Vertical Saas owner's account) and will be deducted from your residual. If you wish to monetize these offerings or pass the fees on to your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you must explicitly link the buyers "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument Association"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payment_instrument_associations","summary":"Create a Payment Instrument Association","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-instrument-associations/createpaymentinstrumentassociation","deprecated":false},{"title":"/payment_instrument_associations","summary":"List Payment Instrument Associations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instrument-associations/listpaymentinstrumentassociations","deprecated":false},{"title":"/payment_instrument_associations/{payment_instrument_association_id}","summary":"Fetch a Payment Instrument Association","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-instrument-associations/getpaymentinstrumentassociation","deprecated":false},{"title":"/payment_instrument_associations/{payment_instrument_association_id}","summary":"Update a Payment Instrument Association","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-instrument-associations/updatepaymentinstrumentassociation","deprecated":false}]}]}]}]}},{"type":"group","label":"Settlements","link":"/api/settlements","routeSlug":"/api/settlements","items":[{"label":"List Settlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlements","routeSlug":"/api/settlements/listsettlements","metadata":{"seo":{"title":"List Settlements","description":"Retrieve a list of Settlement resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSettlements","name":"List Settlements","isWebhook":false,"pointer":"/paths/~1settlements/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List 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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"funding_transfer_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funding_transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has created."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"is_exception","in":"query","schemaId":"schema_18","description":"Filter to return if settlement is an exception settlement."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant_id","in":"query","schemaId":"schema_20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"status","in":"query","schemaId":"schema_120","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Merchants only receive payouts when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payouts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"total_amount","in":"query","schemaId":"schema_121","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equal to the given value."},"children":[]}]}]}]},{"name":"total_amount.lte","in":"query","schemaId":"schema_122","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" less than or equal to the given value."},"children":[]}]}]}]},{"name":"total_amount.lt","in":"query","schemaId":"schema_122","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" less than the given value."},"children":[]}]}]}]},{"name":"total_amount.gte","in":"query","schemaId":"schema_123","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" greater than or equal to the given value."},"children":[]}]}]}]},{"name":"total_amount.gt","in":"query","schemaId":"schema_123","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" greater than the given value."},"children":[]}]}]}]},{"name":"transfer_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has accrued."},"children":[]}]}]}]},{"name":"split_transfer_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has accrued."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlements","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"funding_transfer_id","in":"query","schemaId":"schema_6"},{"name":"id","in":"query","schemaId":"schema_6"},{"name":"is_exception","in":"query","schemaId":"schema_18"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant_id","in":"query","example":"MUeDVrf2ahuKc9Eg5TeZugvs","schemaId":"schema_20"},{"name":"status","in":"query","required":false,"schemaId":"schema_120"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"total_amount","in":"query","schemaId":"schema_121"},{"name":"total_amount.lte","in":"query","example":2000,"schemaId":"schema_122"},{"name":"total_amount.lt","in":"query","example":2000,"schemaId":"schema_122"},{"name":"total_amount.gte","in":"query","example":2,"schemaId":"schema_123"},{"name":"total_amount.gt","in":"query","example":2,"schemaId":"schema_123"},{"name":"transfer_id","in":"query","schemaId":"schema_6"},{"name":"split_transfer_id","in":"query","schemaId":"schema_6"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements","href":"settlements/listsettlements","openApiOperationId":"listSettlements","summary":"List Settlements"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/settlements\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1settlements/get/responses/200/content/application~1json/examples/List of Settlements"]}},"schemaId":"schema_124","exampleIds":["paths/~1settlements/get/responses/200/content/application~1json/examples/List of Settlements"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1settlements/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_124","exampleIds":["paths/~1settlements/get/responses/200/content/application~1json/examples/List of Settlements"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_124","exampleIds":["paths/~1settlements/get/responses/200/content/application~1json/examples/List of Settlements"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/listsettlements"}],"panels":[]}]},"httpPath":"/settlements"},{"label":"Fetch a Settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/getsettlement","routeSlug":"/api/settlements/getsettlement","metadata":{"seo":{"title":"Fetch a Settlement","description":"Retrieve the details of an existing Settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSettlement","name":"Fetch a Settlement","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Settlement","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlements/{settlement_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}","href":"settlements/getsettlement","openApiOperationId":"getSettlement","summary":"Fetch a Settlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Settlement","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/200/content/application~1json/examples/Settlement"]}},"schemaId":"components/schemas/Settlement","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/200/content/application~1json/examples/Settlement"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1settlements~1{settlement_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Settlement","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/200/content/application~1json/examples/Settlement"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Settlement","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/200/content/application~1json/examples/Settlement"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/getsettlement"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}"},{"label":"Close a Settlement","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/closesettlements","routeSlug":"/api/settlements/closesettlements","metadata":{"seo":{"title":"Close a Settlement","description":"Close an accruing Settlement. Finix, by default, creates accruing settlements then closes them based on your payout configurations. Use this endpoint to manually close a specific settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"closesettlements","name":"Close a Settlement","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Close a Settlement","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":"text","inline":true,"attributes":{"content":"Close an accruing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Finix, by default, creates accruing settlements then closes them based on your payout configurations. Use this endpoint to manually close a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement"},"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 closed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will not accrue any further transactions and gets immediately submitted for approval."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important Notes"},"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":"text","inline":true,"attributes":{"content":"This endpoint is only available to Finix Core customers. If you have any questions, please contact the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"mailto:support@finix.com"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix Support Team"},"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":"Any refunded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" get included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a deduction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"PENDING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" don't get included in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlements"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" minus the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"net_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"net_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the amount in cents that gets deposited into the seller's bank account."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/closeSettlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/requestBody/content/application~1json/examples/Close Settlement"]}},"schemaId":"components/schemas/closeSettlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/requestBody/content/application~1json/examples/Close Settlement"],"pointer":"/paths/~1settlements~1{settlement_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settlements/{settlement_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/closeSettlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/requestBody/content/application~1json/examples/Close Settlement"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}","href":"settlements/closesettlements","openApiOperationId":"closesettlements","summary":"Close a Settlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/closeSettlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/requestBody/content/application~1json/examples/Close Settlement"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/closeSettlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/requestBody/content/application~1json/examples/Close Settlement"]}},"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":"A single closed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Settlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/200/content/application~1json/examples/Settlement"]}},"schemaId":"components/schemas/Settlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/200/content/application~1json/examples/Settlement"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1settlements~1{settlement_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Settlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/200/content/application~1json/examples/Settlement"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Settlement","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/200/content/application~1json/examples/Settlement"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/closesettlements"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}"},{"label":"List all Entries in a Settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlemententries","routeSlug":"/api/settlements/listsettlemententries","metadata":{"seo":{"title":"List all Entries in a Settlement","description":"Retrieve a list of every Settlement Entry in a Settlement. A Settlement Entry is an object that describes the item inside of a Settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listsettlemententries","name":"List all Entries in a Settlement","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}~1entries/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Entries in a Settlement","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":"text","inline":true,"attributes":{"content":"Retrieve a list of every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an object that describes the item inside of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can represent a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", custom "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/fees"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/split-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}~1entries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1entries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlements/{settlement_id}/entries","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}/entries","href":"settlements/listsettlemententries","openApiOperationId":"listsettlemententries","summary":"List all Entries in a Settlement"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/200/content/application~1json/examples/List of Settlement Entries"]}},"schemaId":"schema_126","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/200/content/application~1json/examples/List of Settlement Entries"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1settlements~1{settlement_id}~1entries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_126","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/200/content/application~1json/examples/List of Settlement Entries"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_126","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/200/content/application~1json/examples/List of Settlement Entries"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/listsettlemententries"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}/entries"},{"label":"Delete Settlement Entries","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/removesettlemententries","routeSlug":"/api/settlements/removesettlemententries","metadata":{"seo":{"title":"Delete Settlement Entries","description":"Remove a Settlement Entry or list of Settlement Entries that make up a Settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeSettlementEntries","name":"Delete Settlement Entries","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}~1entries/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Settlement Entries","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":"text","inline":true,"attributes":{"content":"Remove a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that make up a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"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":"As long as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been funded, you can remove the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", along with its corresponding fee entry from the encompassing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"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 response body is empty after sending a successful delete request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}~1entries/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1entries/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/removeSettlementEntries","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/requestBody/content/application~1json/examples/Remove Settlement Entries"]}},"schemaId":"components/schemas/removeSettlementEntries","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/requestBody/content/application~1json/examples/Remove Settlement Entries"],"pointer":"/paths/~1settlements~1{settlement_id}~1entries/delete/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settlements/{settlement_id}/entries","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/removeSettlementEntries","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/requestBody/content/application~1json/examples/Remove Settlement Entries"]}},"responseCodes":["204","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}/entries","href":"settlements/removesettlemententries","openApiOperationId":"removeSettlementEntries","summary":"Delete Settlement Entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/removeSettlementEntries","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/requestBody/content/application~1json/examples/Remove Settlement Entries"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/removeSettlementEntries","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/requestBody/content/application~1json/examples/Remove Settlement Entries"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Content. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources were successfully removed."},"children":[]}]}]}]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1settlements~1{settlement_id}~1entries/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1entries/delete/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/removesettlemententries"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}/entries"},{"label":"List Settlement Fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlementfees","routeSlug":"/api/settlements/listsettlementfees","metadata":{"seo":{"title":"List Settlement Fees","description":"Retrieve a list of Fee resources belonging to a Settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSettlementFees","name":"List Settlement Fees","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}~1fees/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Settlement Fees","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/fees"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources belonging to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":"Enter the Settlement ID to list its Fees.","required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}~1fees/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1fees/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1fees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlements/{settlement_id}/fees","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}/fees","href":"settlements/listsettlementfees","openApiOperationId":"listSettlementFees","summary":"List Settlement Fees"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/settlements/STcybLTETtjJyUn1WSBqfdW/fees\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u UScqdujkw6kRPSS9DonK7byN:89323567-144b-4b44-8cb7-6aa1965ca608\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/200/content/application~1json/examples/List of Fees"]}},"schemaId":"schema_59","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/200/content/application~1json/examples/List of Fees"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1settlements~1{settlement_id}~1fees/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_59","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/200/content/application~1json/examples/List of Fees"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/200/content/application~1json/examples/List of Fees"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/listsettlementfees"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}/fees"},{"label":"List Settlement Funding Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlementfundingtransfers","routeSlug":"/api/settlements/listsettlementfundingtransfers","metadata":{"seo":{"title":"List Settlement Funding Transfers","description":"List the funding Transfer resources created when a Settlement was approved with a type of CREDIT or DEBIT."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSettlementFundingTransfers","name":"List Settlement Funding Transfers","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Settlement Funding Transfers","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":"text","inline":true,"attributes":{"content":"List the funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources created when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was approved with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlements/{settlement_id}/funding_transfers","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}/funding_transfers","href":"settlements/listsettlementfundingtransfers","openApiOperationId":"listSettlementFundingTransfers","summary":"List Settlement Funding Transfers"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfers"]}},"schemaId":"schema_127","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfers"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_127","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfers"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/listsettlementfundingtransfers"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}/funding_transfers"},{"label":"Delete Settlement Transfers","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/removesettlementtransfers","routeSlug":"/api/settlements/removesettlementtransfers","metadata":{"seo":{"title":"Delete Settlement Transfers","description":"This endpoint is deprecated.Use Delete Settlement Entries instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeSettlementTransfers","name":"Delete Settlement Transfers","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Settlement Transfers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"settlements/removesettlementtransfers/request/this-endpoint-is-deprecated.","deepLinkHash":"/settlements/removesettlementtransfers#settlements/removesettlementtransfers/request/this-endpoint-is-deprecated."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"u","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/settlements/removesettlemententries"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete Settlement Entries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove one or more "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects that make up a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"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":"As long as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been funded, you can remove the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an array of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", along with its corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the encompassing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"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":"Funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response body is empty after sending a successful delete request."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/deleteSettlementTransfers","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/requestBody/content/application~1json/examples/Remove a Transfer in a Settlement"]}},"schemaId":"components/schemas/deleteSettlementTransfers","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/requestBody/content/application~1json/examples/Remove a Transfer in a Settlement"],"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/delete/requestBody","description":[{"$$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":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" IDs to be removed from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settlements/{settlement_id}/transfers","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/deleteSettlementTransfers","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/requestBody/content/application~1json/examples/Remove a Transfer in a Settlement"]}},"responseCodes":["204","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}/transfers","href":"settlements/removesettlementtransfers","openApiOperationId":"removeSettlementTransfers","summary":"Delete Settlement Transfers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/deleteSettlementTransfers","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/requestBody/content/application~1json/examples/Remove a Transfer in a Settlement"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/deleteSettlementTransfers","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/requestBody/content/application~1json/examples/Remove a Transfer in a Settlement"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Content. The settlement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was successfully removed."},"children":[]}]}]}]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/delete/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/removesettlementtransfers"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}/transfers"},{"label":"List all Transfers in a Settlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlementtransfers","routeSlug":"/api/settlements/listsettlementtransfers","metadata":{"seo":{"title":"List all Transfers in a Settlement","description":"This endpoint is deprecated.Use List all Entries in a Settlement instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSettlementTransfers","name":"List all Transfers in a Settlement","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all Transfers in a Settlement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"heading","attributes":{"level":5,"id":"settlements/listsettlementtransfers/request/this-endpoint-is-deprecated.","deepLinkHash":"/settlements/listsettlementtransfers#settlements/listsettlementtransfers/request/this-endpoint-is-deprecated."},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"u","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is deprecated"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/settlements/listsettlemententries"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List all Entries in a Settlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve a list of every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that has a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is not an exhaustive list of everything that comprises a settlement. We recommend using  "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/listSettlementEntries"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Settlement Entries"},"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":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlements/{settlement_id}/transfers","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}/transfers","href":"settlements/listsettlementtransfers","openApiOperationId":"listSettlementTransfers","summary":"List all Transfers in a Settlement"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/settlements/STivxR2KrnVdD75TQtitnsG8/transfers\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of settlement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/200/content/application~1json/examples/List of Settlement Transfers"]}},"schemaId":"schema_127","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/200/content/application~1json/examples/List of Settlement Transfers"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1settlements~1{settlement_id}~1transfers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_127","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/200/content/application~1json/examples/List of Settlement Transfers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/200/content/application~1json/examples/List of Settlement Transfers"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/listsettlementtransfers"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}/transfers"},{"label":"List Settlement Funding Transfer Attempts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/listsettlementfundingtransferattempts","routeSlug":"/api/settlements/listsettlementfundingtransferattempts","metadata":{"seo":{"title":"List Settlement Funding Transfer Attempts","description":"Lists all settlement Funding Transfer Attempt resources associated for the Settlement. A Funding Transfer Attempt resource is created when requesting an instant payout of funds for the Settlement."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSettlementFundingTransferAttempts","name":"List Settlement Funding Transfer Attempts","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Settlement Funding Transfer Attempts","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":"text","inline":true,"attributes":{"content":"Lists all settlement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources associated for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is created when "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/settlements/createsettlementfundingtransferattempt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requesting an instant payout of funds"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlements/{settlement_id}/funding_transfer_attempts","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}/funding_transfer_attempts","href":"settlements/listsettlementfundingtransferattempts","openApiOperationId":"listSettlementFundingTransferAttempts","summary":"List Settlement Funding Transfer Attempts"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfer Attempts"]}},"schemaId":"schema_128","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfer Attempts"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_128","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfer Attempts"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_128","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfer Attempts"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/listsettlementfundingtransferattempts"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}/funding_transfer_attempts"},{"label":"Create Settlement Funding Transfer Attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlements/createsettlementfundingtransferattempt","routeSlug":"/api/settlements/createsettlementfundingtransferattempt","metadata":{"seo":{"title":"Create Settlement Funding Transfer Attempt","description":"Create a Funding Transfer Attempt for this Settlement. Funding transfer attempts are used to submit funds for instant payout."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSettlementFundingTransferAttempt","name":"Create Settlement Funding Transfer Attempt","isWebhook":false,"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Settlement Funding Transfer Attempt","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Funding transfer attempts are used to submit funds for instant payout."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_id","in":"path","schemaId":"schema_125","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"STRQWumUFMWzRAuGL91BUtg"}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createSettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/requestBody/content/application~1json/examples/Create Settlement Funding Transfer Attempt"]}},"schemaId":"components/schemas/createSettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/requestBody/content/application~1json/examples/Create Settlement Funding Transfer Attempt"],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settlements/{settlement_id}/funding_transfer_attempts","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_id","in":"path","required":true,"example":"STRQWumUFMWzRAuGL91BUtg","schemaId":"schema_125"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createSettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/requestBody/content/application~1json/examples/Create Settlement Funding Transfer Attempt"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlements/{settlement_id}/funding_transfer_attempts","href":"settlements/createsettlementfundingtransferattempt","openApiOperationId":"createSettlementFundingTransferAttempt","summary":"Create Settlement Funding Transfer Attempt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createSettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/requestBody/content/application~1json/examples/Create Settlement Funding Transfer Attempt"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createSettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/requestBody/content/application~1json/examples/Create Settlement Funding Transfer Attempt"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single settlement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/201/content/application~1json/examples/Settlement Funding Transfer Attempt"]}},"schemaId":"components/schemas/SettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/201/content/application~1json/examples/Settlement Funding Transfer Attempt"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/SettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/201/content/application~1json/examples/Settlement Funding Transfer Attempt"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SettlementFundingTransferAttempt","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/201/content/application~1json/examples/Settlement Funding Transfer Attempt"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlements/createsettlementfundingtransferattempt"}],"panels":[]}]},"httpPath":"/settlements/{settlement_id}/funding_transfer_attempts"}],"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":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents a collection (i.e. batch) of Settlement Entries that will get paid out to a specific "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can represent a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", custom "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/fees"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/split-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transfer"},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payouts"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settlements","summary":"List Settlements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/listsettlements","deprecated":false},{"title":"/settlements/{settlement_id}","summary":"Fetch a Settlement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/getsettlement","deprecated":false},{"title":"/settlements/{settlement_id}","summary":"Close a Settlement","prefix":{"name":"put","color":"put"},"badges":[],"link":"/settlements/closesettlements","deprecated":false},{"title":"/settlements/{settlement_id}/entries","summary":"List all Entries in a Settlement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/listsettlemententries","deprecated":false},{"title":"/settlements/{settlement_id}/entries","summary":"Delete Settlement Entries","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/settlements/removesettlemententries","deprecated":false},{"title":"/settlements/{settlement_id}/fees","summary":"List Settlement Fees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/listsettlementfees","deprecated":false},{"title":"/settlements/{settlement_id}/funding_transfers","summary":"List Settlement Funding Transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/listsettlementfundingtransfers","deprecated":false},{"title":"/settlements/{settlement_id}/transfers","summary":"Delete Settlement Transfers","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/settlements/removesettlementtransfers","deprecated":false},{"title":"/settlements/{settlement_id}/transfers","summary":"List all Transfers in a Settlement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/listsettlementtransfers","deprecated":false},{"title":"/settlements/{settlement_id}/funding_transfer_attempts","summary":"List Settlement Funding Transfer Attempts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlements/listsettlementfundingtransferattempts","deprecated":false},{"title":"/settlements/{settlement_id}/funding_transfer_attempts","summary":"Create Settlement Funding Transfer Attempt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settlements/createsettlementfundingtransferattempt","deprecated":false}]}]}]}]}},{"type":"group","label":"Settlement Queue Entries","link":"/api/settlement-queue-entries","routeSlug":"/api/settlement-queue-entries","items":[{"label":"List Settlement Queue Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlement-queue-entries/listsettlementqueueentries","routeSlug":"/api/settlement-queue-entries/listsettlementqueueentries","metadata":{"seo":{"title":"List Settlement Queue Entries","description":"Retrieve a list of Settlement Queue Entry resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSettlementQueueEntries","name":"List Settlement Queue Entries","isWebhook":false,"pointer":"/paths/~1settlement_queue_entries/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Settlement Queue Entries","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"entity_id","in":"query","schemaId":"schema_129","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the resource inside the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"entity_type","in":"query","schemaId":"schema_130","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant_id","in":"query","schemaId":"schema_20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"ready_to_settle_after.gte","in":"query","schemaId":"schema_131","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_to_settle_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"ready_to_settle_after.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_to_settle_after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_132","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1settlement_queue_entries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlement_queue_entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlement_queue_entries","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"entity_id","in":"query","example":"TRdhp3DszqDKbNvwtn7DDcUi","schemaId":"schema_129"},{"name":"entity_type","in":"query","example":"TRANSFER","schemaId":"schema_130"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant_id","in":"query","example":"MUeDVrf2ahuKc9Eg5TeZugvs","schemaId":"schema_20"},{"name":"ready_to_settle_after.gte","in":"query","example":"2023-06-28T00:00:00","schemaId":"schema_131"},{"name":"ready_to_settle_after.lte","in":"query","example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"state","in":"query","example":"PENDING","schemaId":"schema_132"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlement_queue_entries","href":"settlement-queue-entries/listsettlementqueueentries","openApiOperationId":"listSettlementQueueEntries","summary":"List Settlement Queue Entries"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/settlement_queue_entries\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133","exampleIds":["paths/~1settlement_queue_entries/get/responses/200/content/application~1json/examples/List of Settlement Queue Entries"]}},"schemaId":"schema_133","exampleIds":["paths/~1settlement_queue_entries/get/responses/200/content/application~1json/examples/List of Settlement Queue Entries"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1settlement_queue_entries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_133","exampleIds":["paths/~1settlement_queue_entries/get/responses/200/content/application~1json/examples/List of Settlement Queue Entries"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_133","exampleIds":["paths/~1settlement_queue_entries/get/responses/200/content/application~1json/examples/List of Settlement Queue Entries"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement-queue-entries/listsettlementqueueentries"}],"panels":[]}]},"httpPath":"/settlement_queue_entries"},{"label":"Release Settlement Queue Entries","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlement-queue-entries/updatesettlementqueueentries","routeSlug":"/api/settlement-queue-entries/updatesettlementqueueentries","metadata":{"seo":{"title":"Release Settlement Queue Entries","description":"This action is used to release a number of Settlement Queue Entry resources, allowing them to be included in a Settlement as Settlement Entry resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSettlementQueueEntries","name":"Release Settlement Queue Entries","isWebhook":false,"pointer":"/paths/~1settlement_queue_entries/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Release Settlement Queue Entries","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":"text","inline":true,"attributes":{"content":"This action is used to release a number of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources, allowing them to be included in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlement_queue_entries/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/releaseSettlementQueueEntries","exampleIds":["paths/~1settlement_queue_entries/put/requestBody/content/application~1json/examples/Update Settlement Queue Entries"]}},"schemaId":"components/schemas/releaseSettlementQueueEntries","exampleIds":["paths/~1settlement_queue_entries/put/requestBody/content/application~1json/examples/Update Settlement Queue Entries"],"pointer":"/paths/~1settlement_queue_entries/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settlement_queue_entries","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/releaseSettlementQueueEntries","exampleIds":["paths/~1settlement_queue_entries/put/requestBody/content/application~1json/examples/Update Settlement Queue Entries"]}},"responseCodes":["204","400","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlement_queue_entries","href":"settlement-queue-entries/updatesettlementqueueentries","openApiOperationId":"updateSettlementQueueEntries","summary":"Release Settlement Queue Entries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/releaseSettlementQueueEntries","exampleIds":["paths/~1settlement_queue_entries/put/requestBody/content/application~1json/examples/Update Settlement Queue Entries"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/releaseSettlementQueueEntries","exampleIds":["paths/~1settlement_queue_entries/put/requestBody/content/application~1json/examples/Update Settlement Queue Entries"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content. The request was successful, but there is no representation to return (i.e., the response is empty).","headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/422/content/application~1json/examples/Invalid action"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/422/content/application~1json/examples/Invalid action"]}],"pointer":"/paths/~1settlement_queue_entries/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/422/content/application~1json/examples/Invalid action"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries/put/responses/422/content/application~1json/examples/Invalid action"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement-queue-entries/updatesettlementqueueentries"}],"panels":[]}]},"httpPath":"/settlement_queue_entries"},{"label":"Fetch a Settlement Queue Entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/settlement-queue-entries/getsettlementqueueentry","routeSlug":"/api/settlement-queue-entries/getsettlementqueueentry","metadata":{"seo":{"title":"Fetch a Settlement Queue Entry","description":"Retrieve the details of a Settlement Queue Entry created from a Transfer, Fee, or Reversal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSettlementQueueEntry","name":"Fetch a Settlement Queue Entry","isWebhook":false,"pointer":"/paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Settlement Queue Entry","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":"text","inline":true,"attributes":{"content":"Retrieve the details of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"settlement_queue_entry_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M"}],"pointer":"/paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settlement_queue_entries/{settlement_queue_entry_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"settlement_queue_entry_id","in":"path","required":true,"example":"settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/settlement_queue_entries/{settlement_queue_entry_id}","href":"settlement-queue-entries/getsettlementqueueentry","openApiOperationId":"getSettlementQueueEntry","summary":"Fetch a Settlement Queue Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/settlement_queue_entry","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/200/content/application~1json/examples/Settlement Queue Entry"]}},"schemaId":"components/schemas/settlement_queue_entry","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/200/content/application~1json/examples/Settlement Queue Entry"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/settlement_queue_entry","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/200/content/application~1json/examples/Settlement Queue Entry"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/settlement_queue_entry","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/200/content/application~1json/examples/Settlement Queue Entry"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settlement-queue-entries/getsettlementqueueentry"}],"panels":[]}]},"httpPath":"/settlement_queue_entries/{settlement_queue_entry_id}"}],"content":{"contentType":"group","meta":{"name":"Settlement Queue Entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settlement Queue Entries","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents an entry in the settlement queue used to track when and how a transfer is queued to be processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"settlement_queue_mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANUAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all transfers will have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created and will not be placed into settlement until the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/settlement-queue-entries/updatesettlementqueueentries"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settlement Queue Entry is explicitly released"},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/additional-resources/developers/resources-and-payment-flows/key-resources#settlements"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Structures and Settlements"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settlement_queue_entries","summary":"List Settlement Queue Entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlement-queue-entries/listsettlementqueueentries","deprecated":false},{"title":"/settlement_queue_entries","summary":"Release Settlement Queue Entries","prefix":{"name":"put","color":"put"},"badges":[],"link":"/settlement-queue-entries/updatesettlementqueueentries","deprecated":false},{"title":"/settlement_queue_entries/{settlement_queue_entry_id}","summary":"Fetch a Settlement Queue Entry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settlement-queue-entries/getsettlementqueueentry","deprecated":false}]}]}]}]}},{"type":"group","label":"Split Transfers","link":"/api/split-transfers","routeSlug":"/api/split-transfers","items":[{"label":"List Fees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/split-transfers/listfees","routeSlug":"/api/split-transfers/listfees","metadata":{"seo":{"title":"List Fees","description":"Retrieve a list of Fee resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFees","name":"List Fees","isWebhook":false,"pointer":"/paths/~1fees/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Fees","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"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":"Filter fees by linked entity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You can filter fees by the entity that generated them using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter:"},"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":"Transfer fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=TRnErBfrHLgdAi3BqAkWLN27"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=AUg8unYpnWBEY1AdVUDkdQYJ"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split transfer fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=split_transfer_split_transfer_97gaitUpcmzqjYYpQbei9j"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compliance Form fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=cf_uwErNm23TKYNEiqrEdJK59"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=PInVUXZLswZi6pdcK1T41MuE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant-specific fees: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?linked_to=MUwfZPNW3r4EqLMzwgr6txw4"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant-specific fees include monthly dues and assessments and any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/fees/createfee"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"custom fees"},"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":"To show fees charged to a specific entity during a period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at.gte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at.lte"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"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":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?merchant_id=MUeDVrf2ahuKc9Eg5TeZugvs&created_at.lte=2025-01-01&created_at.gte=2025-02-01"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"linked_to","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the resource that generated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"TRrB2VG7H84LmRgSTkfR2Cb6"},{"name":"merchant_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was charged fees."},"children":[]}]}]}],"example":"MUeDVrf2ahuKc9Eg5TeZugvs"},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1fees/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1fees/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fees","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"linked_to","in":"query","required":false,"example":"TRrB2VG7H84LmRgSTkfR2Cb6","schemaId":"schema_6"},{"name":"merchant_id","in":"query","required":false,"example":"MUeDVrf2ahuKc9Eg5TeZugvs","schemaId":"schema_6"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/fees","href":"split-transfers/listfees","openApiOperationId":"listFees","summary":"List Fees"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/fees\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"]}},"schemaId":"schema_59","exampleIds":["paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1fees/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_59","exampleIds":["paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_59","exampleIds":["paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/split-transfers/listfees"}],"panels":[]}]},"httpPath":"/fees"},{"label":"List Split Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/split-transfers/listsplittransfers","routeSlug":"/api/split-transfers/listsplittransfers","metadata":{"seo":{"title":"List Split Transfers","description":"Retrieve a list of Split Transfer resources created for a specific split Transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSplitTransfers","name":"List Split Transfers","isWebhook":false,"pointer":"/paths/~1split_transfers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Split Transfers","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources created for a specific split "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"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":"For more information, see our "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/split-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1split_transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1split_transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/split_transfers","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/split_transfers","href":"split-transfers/listsplittransfers","openApiOperationId":"listSplitTransfers","summary":"List Split Transfers"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/split_transfers?parent_transfer_id=TRvQN3v5mhA2Ttc78hzjLV3j\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created for a split "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134","exampleIds":["paths/~1split_transfers/get/responses/200/content/application~1json/examples/List of Split Transfers"]}},"schemaId":"schema_134","exampleIds":["paths/~1split_transfers/get/responses/200/content/application~1json/examples/List of Split Transfers"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1split_transfers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_134","exampleIds":["paths/~1split_transfers/get/responses/200/content/application~1json/examples/List of Split Transfers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_134","exampleIds":["paths/~1split_transfers/get/responses/200/content/application~1json/examples/List of Split Transfers"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/split-transfers/listsplittransfers"}],"panels":[]}]},"httpPath":"/split_transfers"},{"label":"Fetch a Split Transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/split-transfers/getsplittransfer","routeSlug":"/api/split-transfers/getsplittransfer","metadata":{"seo":{"title":"Fetch a Split Transfer","description":"Fetch a Split Transfer that was created from a split transaction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSplitTransfer","name":"Fetch a Split Transfer","isWebhook":false,"pointer":"/paths/~1split_transfers~1{split_transfer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Split Transfer","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":"text","inline":true,"attributes":{"content":"Fetch a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was created from a split transaction."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"split_transfer_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"split_transfer_97gaitUpcmzqjYYpQbei9j"}],"pointer":"/paths/~1split_transfers~1{split_transfer_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1split_transfers~1{split_transfer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/split_transfers/{split_transfer_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"split_transfer_id","in":"path","required":true,"example":"split_transfer_97gaitUpcmzqjYYpQbei9j","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/split_transfers/{split_transfer_id}","href":"split-transfers/getsplittransfer","openApiOperationId":"getSplitTransfer","summary":"Fetch a Split Transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/split_transfer","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/200/content/application~1json/examples/Split Transfer"]}},"schemaId":"components/schemas/split_transfer","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/200/content/application~1json/examples/Split Transfer"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1split_transfers~1{split_transfer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/split_transfer","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/200/content/application~1json/examples/Split Transfer"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/split_transfer","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/200/content/application~1json/examples/Split Transfer"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1split_transfers~1{split_transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/split-transfers/getsplittransfer"}],"panels":[]}]},"httpPath":"/split_transfers/{split_transfer_id}"}],"content":{"contentType":"group","meta":{"name":"Split Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Split Transfers","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":"Transactions can be split among different merchants. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shows how funds from a split "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" were distributed into a merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/split-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fees","summary":"List Fees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/split-transfers/listfees","deprecated":false},{"title":"/split_transfers","summary":"List Split Transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/split-transfers/listsplittransfers","deprecated":false},{"title":"/split_transfers/{split_transfer_id}","summary":"Fetch a Split Transfer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/split-transfers/getsplittransfer","deprecated":false}]}]}]}]}},{"type":"group","label":"Transfers","link":"/api/transfers","routeSlug":"/api/transfers","items":[{"label":"Create a Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/createtransfer","routeSlug":"/api/transfers/createtransfer","metadata":{"seo":{"title":"Create a Transfer","description":"Create a Transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTransfer","name":"Create a Transfer","isWebhook":false,"pointer":"/paths/~1transfers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Transfer","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transfers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_135","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"]}},"schemaId":"schema_135","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"],"pointer":"/paths/~1transfers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_135","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"]}},"responseCodes":["201","400","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/transfers","href":"transfers/createtransfer","openApiOperationId":"createTransfer","summary":"Create a Transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_135","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_135","exampleIds":["paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank - Same Day","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"]}},"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/422/content/application~1json/examples/Source instrument not found","paths/~1transfers/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together","paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument","paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session already used"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/422/content/application~1json/examples/Source instrument not found","paths/~1transfers/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together","paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument","paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session already used"]}],"pointer":"/paths/~1transfers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Minimal Fields","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - All Fields","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Canada - EFT","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure Session","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout - Same Day","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Convenience Fee","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Payout","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Verification Checks","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Debit Bank Account","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Fee Profile","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Motor Vehicle Rental","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Lodging","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Gaming","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 2 Processing","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 3 Processing","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Partial Authorization","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Recurring or Unscheduled","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Rent Surcharge","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Split Transaction","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Surcharge","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Card","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank","paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/422/content/application~1json/examples/Source instrument not found","paths/~1transfers/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together","paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument","paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session already used"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/post/responses/422/content/application~1json/examples/Source instrument not found","paths/~1transfers/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together","paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument","paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session already used"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/createtransfer"}],"panels":[]}]},"httpPath":"/transfers"},{"label":"List Transfers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/listtransfers","routeSlug":"/api/transfers/listtransfers","metadata":{"seo":{"title":"List Transfers","description":"Retrieve a list of Transfers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransfers","name":"List Transfers","isWebhook":false,"pointer":"/paths/~1transfers/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Transfers","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"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":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no query parameters are specified in the request the API automatically limits the response to records from the last 30 days. You can request older data by passing an explicit created_at.lte filter."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"amount.gt","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than."},{"name":"amount.gte","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than or equal."},{"name":"amount.lt","in":"query","schemaId":"schema_7","description":"Filter by an amount less than."},{"name":"amount.lte","in":"query","schemaId":"schema_7","description":"Filter by an amount less than or equal."},{"name":"amount","in":"query","schemaId":"schema_7","description":"Filter by an amount equal to the given value."},{"name":"bank_return_reason_code","in":"query","schemaId":"schema_136","description":"Filter bank reversals by ACH Return Code. Use comma-separation to query for multiple values."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"buyer_business_name","in":"query","schemaId":"schema_69","description":"Filter by the Buyer Identity's business name (exact match)."},{"name":"buyer_business_name.like","in":"query","schemaId":"schema_83","description":"Filter by the Buyer Identity's business name (partial match)."},{"name":"buyer_doing_business_as","in":"query","schemaId":"schema_69","description":"Filter by the Buyer Identity's Doing Business As (exact match)."},{"name":"buyer_doing_business_as.like","in":"query","schemaId":"schema_83","description":"Filter by the Buyer Identity's Doing Business As (partial match)."},{"name":"buyer_identity_first_name","in":"query","schemaId":"schema_21","description":"Filter by the Buyer Identity's first name (exact match)."},{"name":"buyer_identity_first_name.like","in":"query","schemaId":"schema_137","description":"Filter by the Buyer Identity's first name (partial match)."},{"name":"buyer_identity_id","in":"query","schemaId":"schema_138","description":"Filter by the Buyer Identity's ID."},{"name":"buyer_identity_last_name","in":"query","schemaId":"schema_139","description":"Filter by the Buyer Identity's last name (exact match)."},{"name":"buyer_identity_last_name.like","in":"query","schemaId":"schema_140","description":"Filter by the Buyer Identity's last name (partial match)."},{"name":"buyer_identity_name","in":"query","schemaId":"schema_141","description":"Filter by the Buyer Identity's full personal name (exact match)."},{"name":"buyer_identity_name.like","in":"query","schemaId":"schema_142","description":"Filter by the Buyer Identity's full personal name (partial match)."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"currency","in":"query","schemaId":"schema_10","description":"Filter by the currency of the resource."},{"name":"device","in":"query","schemaId":"schema_11","description":"Filter by the device's ID."},{"name":"id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"idempotency_id","in":"query","schemaId":"schema_12","description":"Filter by Idempotency ID."},{"name":"instrument_account_last4","in":"query","schemaId":"schema_143","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BANK_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Payment Instruments, filter by the last-4 digits of the bank account number (i.e., from the Payment Instrument's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"masked_account_number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"instrument_bin","in":"query","schemaId":"schema_144","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Payment Instruments, filter by the first-6 digits of the card's number (i.e., the Payment Instrument's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"instrument_brand_type","in":"query","schemaId":"schema_145","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Payment Instruments, filter by the card's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"brand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"instrument_card_last4","in":"query","schemaId":"schema_146","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Payment Instruments, filter by the last-4 digits of the card's number (i.e., the Payment Instrument's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_four"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"instrument_issuer_country","in":"query","schemaId":"schema_147","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Payment Instruments, filter by the card's issuing country (i.e., the Payment Instrument's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuer_country"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Use comma-separation to query for multiple values."},"children":[]}]}]}]},{"name":"instrument_name","in":"query","schemaId":"schema_148","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Payment Instrument's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (exact match)."},"children":[]}]}]}]},{"name":"instrument_type","in":"query","schemaId":"schema_149","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Payment Instrument's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant","in":"query","schemaId":"schema_150","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's ID (i.e., the Transfer's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"merchant_identity_id","in":"query","schemaId":"schema_151","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's Identity ID (i.e., the Transfer's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"merchant_identity_name","in":"query","schemaId":"schema_69","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's name (i.e., the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"merchant_mid","in":"query","schemaId":"schema_152","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's Merchant Identification Number (MID) (i.e., the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"merchant_processor_id","in":"query","schemaId":"schema_153","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the Merchant's processor (i.e., the Merchant's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"name":"parent_transfer_id","in":"query","schemaId":"schema_154","description":"Filter by the ID of the parent transfer."},{"name":"ready_to_settle_at.gte","in":"query","schemaId":"schema_131","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_to_settle_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date. Only available on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Finix-Version: 2022-02-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"ready_to_settle_at.lte","in":"query","schemaId":"schema_131","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_to_settle_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date. Only available on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Finix-Version: 2022-02-01"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_155","description":"Filter by the transfer's state."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"trace_id","in":"query","schemaId":"schema_26","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trace_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"type","in":"query","schemaId":"schema_156","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1transfers/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transfers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"amount.gt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"bank_return_reason_code","in":"query","example":"R03,R07","schemaId":"schema_136"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"buyer_business_name","in":"query","example":"Finix%20Flowers","schemaId":"schema_69"},{"name":"buyer_business_name.like","in":"query","example":"finix","schemaId":"schema_83"},{"name":"buyer_doing_business_as","in":"query","example":"Finix%20Flowers","schemaId":"schema_69"},{"name":"buyer_doing_business_as.like","in":"query","example":"finix","schemaId":"schema_83"},{"name":"buyer_identity_first_name","in":"query","example":"John","schemaId":"schema_21"},{"name":"buyer_identity_first_name.like","in":"query","example":"joh","schemaId":"schema_137"},{"name":"buyer_identity_id","in":"query","example":"ID6Qm3BQUxGFcCWZ185TS8sn","schemaId":"schema_138"},{"name":"buyer_identity_last_name","in":"query","example":"Doe","schemaId":"schema_139"},{"name":"buyer_identity_last_name.like","in":"query","example":"do","schemaId":"schema_140"},{"name":"buyer_identity_name","in":"query","example":"John%20Doe","schemaId":"schema_141"},{"name":"buyer_identity_name.like","in":"query","example":"john","schemaId":"schema_142"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"currency","in":"query","required":false,"example":"USD","schemaId":"schema_10"},{"name":"device","in":"query","example":"DVsEanpBtsAVvCHbNXkFaH6f","schemaId":"schema_11"},{"name":"id","in":"query","schemaId":"schema_6"},{"name":"idempotency_id","in":"query","example":"15d32948-c766-4033-8d87-dfbdcabcbc5c","schemaId":"schema_12"},{"name":"instrument_account_last4","in":"query","example":1234,"schemaId":"schema_143"},{"name":"instrument_bin","in":"query","example":601100,"schemaId":"schema_144","style":"form"},{"name":"instrument_brand_type","in":"query","example":"MASTERCARD","schemaId":"schema_145"},{"name":"instrument_card_last4","in":"query","example":4242,"schemaId":"schema_146"},{"name":"instrument_issuer_country","in":"query","example":"USA,CAN","schemaId":"schema_147"},{"name":"instrument_name","in":"query","example":"Business%20Card","schemaId":"schema_148"},{"name":"instrument_type","in":"query","example":"PAYMENT_CARD","schemaId":"schema_149"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant","in":"query","example":"MUtAWVfXkf149BVi2cL2HvPU","schemaId":"schema_150"},{"name":"merchant_identity_id","in":"query","example":"IDtX3ciHPq2DDquCQJRwj7VW","schemaId":"schema_151"},{"name":"merchant_identity_name","in":"query","example":"Finix%20Flowers","schemaId":"schema_69"},{"name":"merchant_mid","in":"query","example":"FNXkitpwdmgMJ8Vz9FxKBCSza","schemaId":"schema_152"},{"name":"merchant_processor_id","in":"query","example":"DUMMY_V1","schemaId":"schema_153"},{"name":"parent_transfer_id","in":"query","example":"TRjAnCNNSxDCW8GDsxYobHHe","schemaId":"schema_154"},{"name":"ready_to_settle_at.gte","in":"query","example":"2023-06-28T00:00:00","schemaId":"schema_131"},{"name":"ready_to_settle_at.lte","in":"query","example":"2023-06-28T00:00:00","schemaId":"schema_131"},{"name":"state","in":"query","example":"SUCCEEDED","schemaId":"schema_155"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"trace_id","in":"query","required":false,"example":"021fc4ed-f0a8-4932-820c-b22b542526f8","schemaId":"schema_26"},{"name":"type","in":"query","example":"REVERSAL","schemaId":"schema_156"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/transfers","href":"transfers/listtransfers","openApiOperationId":"listTransfers","summary":"List Transfers"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/transfers\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127","exampleIds":["paths/~1transfers/get/responses/200/content/application~1json/examples/List of Transfers"]}},"schemaId":"schema_127","exampleIds":["paths/~1transfers/get/responses/200/content/application~1json/examples/List of Transfers"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1transfers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_127","exampleIds":["paths/~1transfers/get/responses/200/content/application~1json/examples/List of Transfers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127","exampleIds":["paths/~1transfers/get/responses/200/content/application~1json/examples/List of Transfers"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/listtransfers"}],"panels":[]}]},"httpPath":"/transfers"},{"label":"Fetch a Transfer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/gettransfer","routeSlug":"/api/transfers/gettransfer","metadata":{"seo":{"title":"Fetch a Transfer","description":"Retrieve a Transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransfer","name":"Fetch a Transfer","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Transfer","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":"text","inline":true,"attributes":{"content":"Retrieve a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_157","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"required":true,"example":"TRnErBfrHLgdAi3BqAkWLN27"}],"pointer":"/paths/~1transfers~1{transfer_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transfers~1{transfer_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transfer_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"example":"TRnErBfrHLgdAi3BqAkWLN27","schemaId":"schema_157"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/transfers/{transfer_id}","href":"transfers/gettransfer","openApiOperationId":"getTransfer","summary":"Fetch a Transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/200/content/application~1json/examples/Transfer"]}},"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/200/content/application~1json/examples/Transfer"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1transfers~1{transfer_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/200/content/application~1json/examples/Transfer"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/200/content/application~1json/examples/Transfer"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/gettransfer"}],"panels":[]}]},"httpPath":"/transfers/{transfer_id}"},{"label":"Update a Transfer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/updatetransfer","routeSlug":"/api/transfers/updatetransfer","metadata":{"seo":{"title":"Update a Transfer","description":"Update a Transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateTransfer","name":"Update a Transfer","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Transfer","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":"text","inline":true,"attributes":{"content":"Update a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_157","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"required":true,"example":"TRnErBfrHLgdAi3BqAkWLN27"}],"pointer":"/paths/~1transfers~1{transfer_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1transfers~1{transfer_id}/put/requestBody/content/application~1json/examples/Update a Transfer"]}},"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1transfers~1{transfer_id}/put/requestBody/content/application~1json/examples/Update a Transfer"],"pointer":"/paths/~1transfers~1{transfer_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/transfers/{transfer_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"example":"TRnErBfrHLgdAi3BqAkWLN27","schemaId":"schema_157"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1transfers~1{transfer_id}/put/requestBody/content/application~1json/examples/Update a Transfer"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/transfers/{transfer_id}","href":"transfers/updatetransfer","openApiOperationId":"updateTransfer","summary":"Update a Transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1transfers~1{transfer_id}/put/requestBody/content/application~1json/examples/Update a Transfer"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateDispute","exampleIds":["paths/~1transfers~1{transfer_id}/put/requestBody/content/application~1json/examples/Update a Transfer"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/200/content/application~1json/examples/Transfer"]}},"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/200/content/application~1json/examples/Transfer"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1transfers~1{transfer_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/200/content/application~1json/examples/Transfer"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/200/content/application~1json/examples/Transfer"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/updatetransfer"}],"panels":[]}]},"httpPath":"/transfers/{transfer_id}"},{"label":"Refund or Reverse a Transfer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/createtransferreversal","routeSlug":"/api/transfers/createtransferreversal","metadata":{"seo":{"title":"Refund or Reverse a Transfer","description":"Reverse a transfer with a type of DEBIT. This reversal creates a new Transfer resource with a type of REVERSAL."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createTransferReversal","name":"Refund or Reverse a Transfer","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund or Reverse a Transfer","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":"text","inline":true,"attributes":{"content":"Reverse a transfer with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This reversal creates a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVERSAL"},"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":"Related Guides: "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refunding Payments"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_157","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"required":true,"example":"TRnErBfrHLgdAi3BqAkWLN27"}],"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_158","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Card Present Transfer - Referenced"]}},"schemaId":"schema_158","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Card Present Transfer - Referenced"],"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/transfers/{transfer_id}/reversals","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"example":"TRnErBfrHLgdAi3BqAkWLN27","schemaId":"schema_157"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_158","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Card Present Transfer - Referenced"]}},"responseCodes":["201","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/transfers/{transfer_id}/reversals","href":"transfers/createtransferreversal","openApiOperationId":"createTransferReversal","summary":"Refund or Reverse a Transfer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_158","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Card Present Transfer - Referenced"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_158","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Card Present Transfer - Referenced"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$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":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was successfully reversed."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Card Present Transfer - Referenced"]}},"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Card Present Transfer - Referenced"]},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Card Present Transfer - Referenced"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/transfer","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer","paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer - Split Transaction","paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Card Present Transfer - Referenced"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/createtransferreversal"}],"panels":[]}]},"httpPath":"/transfers/{transfer_id}/reversals"},{"label":"List Transfer Reversals","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfers/listtransferreversals","routeSlug":"/api/transfers/listtransferreversals","metadata":{"seo":{"title":"List Transfer Reversals","description":"Retrieve a list of reversals for a Transfer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransferReversals","name":"List Transfer Reversals","isWebhook":false,"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Transfer Reversals","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":"text","inline":true,"attributes":{"content":"Retrieve a list of reversals for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"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":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_id","in":"path","schemaId":"schema_157","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"required":true,"example":"TRnErBfrHLgdAi3BqAkWLN27"}],"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."}],"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfers/{transfer_id}/reversals","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"transfer_id","in":"path","required":true,"example":"TRnErBfrHLgdAi3BqAkWLN27","schemaId":"schema_157"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/transfers/{transfer_id}/reversals","href":"transfers/listtransferreversals","openApiOperationId":"listTransferReversals","summary":"List Transfer Reversals"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/transfers/TRvU2qRMSYGnJY6dcAXehJqd/reversals\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of reversed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/200/content/application~1json/examples/List of Reversed Transfers"]}},"schemaId":"schema_127","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/200/content/application~1json/examples/List of Reversed Transfers"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1transfers~1{transfer_id}~1reversals/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_127","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/200/content/application~1json/examples/List of Reversed Transfers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_127","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/200/content/application~1json/examples/List of Reversed Transfers"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfers~1{transfer_id}~1reversals/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfers/listtransferreversals"}],"panels":[]}]},"httpPath":"/transfers/{transfer_id}/reversals"}],"content":{"contentType":"group","meta":{"name":"Transfers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfers","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents any flow of funds either to or from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". All payments in Finix are represented by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/online-payments/online-payments-quickstart"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Online Payments Quickstart"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/level-2-level-3-processing/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 2 and 3 Processing"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/in-person-payments/building-your-integration/pos-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POS Integration"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"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":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/ach-direct-debits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH (eCheck) Direct Debit"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transfers","summary":"Create a Transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/createtransfer","deprecated":false},{"title":"/transfers","summary":"List Transfers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/listtransfers","deprecated":false},{"title":"/transfers/{transfer_id}","summary":"Fetch a Transfer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/gettransfer","deprecated":false},{"title":"/transfers/{transfer_id}","summary":"Update a Transfer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/transfers/updatetransfer","deprecated":false},{"title":"/transfers/{transfer_id}/reversals","summary":"Refund or Reverse a Transfer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/transfers/createtransferreversal","deprecated":false},{"title":"/transfers/{transfer_id}/reversals","summary":"List Transfer Reversals","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfers/listtransferreversals","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/api/users","routeSlug":"/api/users","items":[{"label":"List Users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/listusers","routeSlug":"/api/users/listusers","metadata":{"seo":{"title":"List Users","description":"Retrieve a list of User resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUsers","name":"List Users","isWebhook":false,"pointer":"/paths/~1users/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Users","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1users/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/users","href":"users/listusers","openApiOperationId":"listUsers","summary":"List Users"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/users\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159","exampleIds":["paths/~1users/get/responses/200/content/application~1json/examples/List of Users"]}},"schemaId":"schema_159","exampleIds":["paths/~1users/get/responses/200/content/application~1json/examples/List of Users"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1users/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_159","exampleIds":["paths/~1users/get/responses/200/content/application~1json/examples/List of Users"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_159","exampleIds":["paths/~1users/get/responses/200/content/application~1json/examples/List of Users"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusers"}],"panels":[]}]},"httpPath":"/users"},{"label":"Fetch a User by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/getuser","routeSlug":"/api/users/getuser","metadata":{"seo":{"title":"Fetch a User by ID","description":"Retrieve the details of an existing User."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Fetch a User by ID","isWebhook":false,"pointer":"/paths/~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a User 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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_160","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"required":true,"example":"USfQxMmbRPkdXYFqGQefC5v4"}],"pointer":"/paths/~1users~1{user_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/users/{user_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"USfQxMmbRPkdXYFqGQefC5v4","schemaId":"schema_160"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/users/{user_id}","href":"users/getuser","openApiOperationId":"getUser","summary":"Fetch a User by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user","exampleIds":["paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/User"]}},"schemaId":"components/schemas/user","exampleIds":["paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/User"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/user","exampleIds":["paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/User"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user","exampleIds":["paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/User"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuser"}],"panels":[]}]},"httpPath":"/users/{user_id}"},{"label":"Update a User","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/users/updateuser","routeSlug":"/api/users/updateuser","metadata":{"seo":{"title":"Update a User","description":"Update a User with new tags or disable the User and their credentials."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUser","name":"Update a User","isWebhook":false,"pointer":"/paths/~1users~1{user_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a User","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":"text","inline":true,"attributes":{"content":"Update a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with new tags or disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and their credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"user_id","in":"path","schemaId":"schema_160","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"required":true,"example":"USfQxMmbRPkdXYFqGQefC5v4"}],"pointer":"/paths/~1users~1{user_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Disable User"]}},"schemaId":"schema_161","exampleIds":["paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Disable User"],"pointer":"/paths/~1users~1{user_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/users/{user_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"user_id","in":"path","required":true,"example":"USfQxMmbRPkdXYFqGQefC5v4","schemaId":"schema_160"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Disable User"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/users/{user_id}","href":"users/updateuser","openApiOperationId":"updateUser","summary":"Update a User"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_161","exampleIds":["paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Disable User"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_161","exampleIds":["paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Disable User"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user","exampleIds":["paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Disable User"]}},"schemaId":"components/schemas/user","exampleIds":["paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Disable User"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1users~1{user_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/user","exampleIds":["paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Disable User"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/user","exampleIds":["paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Update Tags","paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Disable User"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1users~1{user_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateuser"}],"panels":[]}]},"httpPath":"/users/{user_id}"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents a pair of API keys which are used to perform authenticated requests against the Finix API. When making authenticated requests via HTTP basic access authentication the ID of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource maps to the username, while the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to the password (i.e. secret key)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The password field for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is only returned during the initial creation. Any following GET requests to the resource returns the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for security purposes."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/additional-resources/developers/resources-and-payment-flows/key-resources#account-structure"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Structure"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/users","summary":"List Users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listusers","deprecated":false},{"title":"/users/{user_id}","summary":"Fetch a User by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuser","deprecated":false},{"title":"/users/{user_id}","summary":"Update a User","prefix":{"name":"put","color":"put"},"badges":[],"link":"/users/updateuser","deprecated":false}]}]}]}]}},{"type":"group","label":"Verifications","link":"/api/verifications","routeSlug":"/api/verifications","items":[{"label":"List Merchant Verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/verifications/listmerchantverifications","routeSlug":"/api/verifications/listmerchantverifications","metadata":{"seo":{"title":"List Merchant Verifications","description":"Retrieve a list of all the Verifications for a Merchant resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMerchantVerifications","name":"List Merchant Verifications","isWebhook":false,"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Merchant Verifications","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":"text","inline":true,"attributes":{"content":"Retrieve a list of all the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"merchant_id","in":"path","schemaId":"schema_93","description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4"}],"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."}],"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchants/{merchant_id}/verifications","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"merchant_id","in":"path","required":true,"example":"MUwfZPNW3r4EqLMzwgr6txw4","schemaId":"schema_93"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/merchants/{merchant_id}/verifications","href":"verifications/listmerchantverifications","openApiOperationId":"listMerchantVerifications","summary":"List Merchant Verifications"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq/verifications\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Merchant Verifications","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/200/content/application~1json/examples/Merchant Verifications List"]}},"schemaId":"schema_162","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/200/content/application~1json/examples/Merchant Verifications List"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1merchants~1{merchant_id}~1verifications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_162","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/200/content/application~1json/examples/Merchant Verifications List"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_162","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/200/content/application~1json/examples/Merchant Verifications List"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1merchants~1{merchant_id}~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/listmerchantverifications"}],"panels":[]}]},"httpPath":"/merchants/{merchant_id}/verifications"},{"label":"List Verifications","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/verifications/listverifications","routeSlug":"/api/verifications/listverifications","metadata":{"seo":{"title":"List Verifications","description":"Retrieve a list of Verification resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVerifications","name":"List Verifications","isWebhook":false,"pointer":"/paths/~1verifications/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Verifications","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1verifications/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1verifications/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verifications","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/verifications","href":"verifications/listverifications","openApiOperationId":"listVerifications","summary":"List Verifications"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/verifications\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163","exampleIds":["paths/~1verifications/get/responses/200/content/application~1json/examples/List of Verifications"]}},"schemaId":"schema_163","exampleIds":["paths/~1verifications/get/responses/200/content/application~1json/examples/List of Verifications"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1verifications/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_163","exampleIds":["paths/~1verifications/get/responses/200/content/application~1json/examples/List of Verifications"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_163","exampleIds":["paths/~1verifications/get/responses/200/content/application~1json/examples/List of Verifications"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/listverifications"}],"panels":[]}]},"httpPath":"/verifications"},{"label":"Fetch a Verification","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/verifications/getverification","routeSlug":"/api/verifications/getverification","metadata":{"seo":{"title":"Fetch a Verification","description":"Retrieve the details of an existing Verification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVerification","name":"Fetch a Verification","isWebhook":false,"pointer":"/paths/~1verifications~1{verification_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Verification","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"verification_id","in":"path","schemaId":"schema_6","description":[{"$$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":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object ID."},"children":[]}]}]}],"required":true,"example":"VI5pMpAg6e5bRaMREhrYjwQW"}],"pointer":"/paths/~1verifications~1{verification_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1verifications~1{verification_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/verifications/{verification_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"verification_id","in":"path","required":true,"example":"VI5pMpAg6e5bRaMREhrYjwQW","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/verifications/{verification_id}","href":"verifications/getverification","openApiOperationId":"getVerification","summary":"Fetch a Verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Payment Instrument","paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Merchant"]}},"schemaId":"schema_164","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Payment Instrument","paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Merchant"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1verifications~1{verification_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_164","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Payment Instrument","paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Merchant"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_164","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Payment Instrument","paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Merchant"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1verifications~1{verification_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/verifications/getverification"}],"panels":[]}]},"httpPath":"/verifications/{verification_id}"}],"content":{"contentType":"group","meta":{"name":"Verifications"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Verifications","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verifications"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are used to verify "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instruments"},"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":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a verification represents an attempt to onboard and underwrite a Merchant."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a verification represents getting additional information from the card brands to verify a card is eligible for push to card."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-via-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding with the API"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/card-payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push to Card"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/merchants/{merchant_id}/verifications","summary":"List Merchant Verifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verifications/listmerchantverifications","deprecated":false},{"title":"/verifications","summary":"List Verifications","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verifications/listverifications","deprecated":false},{"title":"/verifications/{verification_id}","summary":"Fetch a Verification","prefix":{"name":"get","color":"get"},"badges":[],"link":"/verifications/getverification","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/api/webhooks","routeSlug":"/api/webhooks","items":[{"label":"Create a Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhooks/createwebhook","routeSlug":"/api/webhooks/createwebhook","metadata":{"seo":{"title":"Create a Webhook","description":"Create a Webhook to receive webhook events for specified entities (e.g., transfer, merchant) to a URL provided by you. When an enabled event occurs, Finix sends a POST request to this URL with the webhook event payload."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createWebhook","name":"Create a Webhook","isWebhook":false,"pointer":"/paths/~1webhooks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Webhook","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to receive webhook events for specified entities (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to a URL provided by you. When an enabled event occurs, Finix sends a POST request to this URL with the webhook event payload."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secret_signing_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Store this value securely. It is used to verify that incoming payloads were sent by Finix."},"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":"Authentication"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control how Finix authenticates requests to your endpoint:"},"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":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (default) — No authentication header is sent"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication.basic.username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication.basic.password"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BEARER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Provide "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authentication.bearer.token"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn how to add webhook authentication, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks#creating-authenticated-webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating Authenticated Webhooks"},"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":"Event Filtering"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" subscribes to a standard set of events. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled_events"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to override the default set of events and receive only specific entity/type combinations. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/webhook-events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for supported entities and event types."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1webhooks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Event Filtering"]}},"schemaId":"schema_165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Event Filtering"],"pointer":"/paths/~1webhooks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhooks","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Event Filtering"]}},"responseCodes":["201","400","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/webhooks","href":"webhooks/createwebhook","openApiOperationId":"createWebhook","summary":"Create a Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Event Filtering"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_165","exampleIds":["paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Event Filtering"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Event Filtering"]}},"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Event Filtering"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/422/content/application~1json/examples/Failed to create webhook"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/422/content/application~1json/examples/Failed to create webhook"]}],"pointer":"/paths/~1webhooks/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Event Filtering"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Minimal Fields - No Authentication","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - All Fields","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Basic Authentication","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Bearer Token","paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Event Filtering"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/422/content/application~1json/examples/Failed to create webhook"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/post/responses/422/content/application~1json/examples/Failed to create webhook"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createwebhook"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"List Webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhooks/listwebhooks","routeSlug":"/api/webhooks/listwebhooks","metadata":{"seo":{"title":"List Webhooks","description":"Retrieve a list of Webhook resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWebhooks","name":"List Webhooks","isWebhook":false,"pointer":"/paths/~1webhooks/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Webhooks","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1webhooks/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1webhooks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/webhooks","href":"webhooks/listwebhooks","openApiOperationId":"listWebhooks","summary":"List Webhooks"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/webhooks\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1webhooks/get/responses/200/content/application~1json/examples/List of Webhooks"]}},"schemaId":"schema_166","exampleIds":["paths/~1webhooks/get/responses/200/content/application~1json/examples/List of Webhooks"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1webhooks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_166","exampleIds":["paths/~1webhooks/get/responses/200/content/application~1json/examples/List of Webhooks"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_166","exampleIds":["paths/~1webhooks/get/responses/200/content/application~1json/examples/List of Webhooks"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listwebhooks"}],"panels":[]}]},"httpPath":"/webhooks"},{"label":"Fetch a Webhook","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhooks/getwebhook","routeSlug":"/api/webhooks/getwebhook","metadata":{"seo":{"title":"Fetch a Webhook","description":"Retrieve the details of an existing Webhook."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWebhook","name":"Fetch a Webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhook_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Webhook","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_167","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"required":true,"example":"WHhEyB1GdW8NsP2T7Rv6nfc6"}],"pointer":"/paths/~1webhooks~1{webhook_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1webhooks~1{webhook_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/webhooks/{webhook_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"example":"WHhEyB1GdW8NsP2T7Rv6nfc6","schemaId":"schema_167"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/webhooks/{webhook_id}","href":"webhooks/getwebhook","openApiOperationId":"getWebhook","summary":"Fetch a Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Webhook"]}},"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Webhook"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1webhooks~1{webhook_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Webhook"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Webhook"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/getwebhook"}],"panels":[]}]},"httpPath":"/webhooks/{webhook_id}"},{"label":"Update Webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/webhooks/updatewebhook","routeSlug":"/api/webhooks/updatewebhook","metadata":{"seo":{"title":"Update Webhook","description":"Update an existing Webhook to:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWebhook","name":"Update Webhook","isWebhook":false,"pointer":"/paths/~1webhooks~1{webhook_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Webhook","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":"text","inline":true,"attributes":{"content":"Update an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to:"},"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":"Enable or disable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Disabled webhooks stop receiving events at the configured URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks#creating-authenticated-webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication to a Webhook"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks#filtering-webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Override default event filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by specifying the list of events you are interested in receiving"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"webhook_id","in":"path","schemaId":"schema_167","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"required":true,"example":"WHhEyB1GdW8NsP2T7Rv6nfc6"}],"pointer":"/paths/~1webhooks~1{webhook_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_168","exampleIds":["paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Filter Events"]}},"schemaId":"schema_168","exampleIds":["paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Filter Events"],"pointer":"/paths/~1webhooks~1{webhook_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/webhooks/{webhook_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"webhook_id","in":"path","required":true,"example":"WHhEyB1GdW8NsP2T7Rv6nfc6","schemaId":"schema_167"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_168","exampleIds":["paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Filter Events"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/webhooks/{webhook_id}","href":"webhooks/updatewebhook","openApiOperationId":"updateWebhook","summary":"Update Webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_168","exampleIds":["paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Filter Events"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_168","exampleIds":["paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Filter Events"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Filter Events"]}},"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Filter Events"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1webhooks~1{webhook_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Filter Events"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/webhook","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - All Fields","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events","paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Filter Events"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1webhooks~1{webhook_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/updatewebhook"}],"panels":[]}]},"httpPath":"/webhooks/{webhook_id}"}],"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 let you set up integrations that subscribe to automated notifications (events) on the Finix API. When an enabled event occurs, Finix sends an HTTP POST payload to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s configured URL."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Integrating Webhooks"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/webhook-events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Events"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhooks","summary":"Create a Webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createwebhook","deprecated":false},{"title":"/webhooks","summary":"List Webhooks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listwebhooks","deprecated":false},{"title":"/webhooks/{webhook_id}","summary":"Fetch a Webhook","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/getwebhook","deprecated":false},{"title":"/webhooks/{webhook_id}","summary":"Update Webhook","prefix":{"name":"put","color":"put"},"badges":[],"link":"/webhooks/updatewebhook","deprecated":false}]}]}]}]}},{"type":"separator","label":"Low-Code / No-Code Resources","content":null},{"type":"group","label":"Gateway Integrations","link":"/api/gateway-integrations","routeSlug":"/api/gateway-integrations","items":[{"label":"Create a Gateway Integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/gateway-integrations/creategatewayintegration","routeSlug":"/api/gateway-integrations/creategatewayintegration","metadata":{"seo":{"title":"Create a Gateway Integration","description":"Create a Gateway Integration that connects a Merchant to a third-party payment gateway. At this time, the only supported gateway is Cybersource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGatewayIntegration","name":"Create a Gateway Integration","isWebhook":false,"pointer":"/paths/~1gateway_integrations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Gateway Integration","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/gateway-integrations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that connects a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a third-party payment gateway. At this time, the only supported gateway is Cybersource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If subscribed, a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/webhook-events#gateway-integration-created"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway Integration - Created webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent when the integration is created with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ›"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"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":"When the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/webhook-events#gateway-integration-updated"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway Integration - Updated webhook"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is sent."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1gateway_integrations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createGatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/requestBody/content/application~1json/examples/Gateway Integration"]}},"schemaId":"components/schemas/createGatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/requestBody/content/application~1json/examples/Gateway Integration"],"pointer":"/paths/~1gateway_integrations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/gateway_integrations","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createGatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/requestBody/content/application~1json/examples/Gateway Integration"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/gateway_integrations","href":"gateway-integrations/creategatewayintegration","openApiOperationId":"createGatewayIntegration","summary":"Create a Gateway Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createGatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/requestBody/content/application~1json/examples/Gateway Integration"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createGatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/requestBody/content/application~1json/examples/Gateway Integration"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Gateway Integration","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/responses/201/content/application~1json/examples/Gateway Integration"]}},"schemaId":"components/schemas/GatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/responses/201/content/application~1json/examples/Gateway Integration"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1gateway_integrations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/GatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/responses/201/content/application~1json/examples/Gateway Integration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayIntegration","exampleIds":["paths/~1gateway_integrations/post/responses/201/content/application~1json/examples/Gateway Integration"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gateway-integrations/creategatewayintegration"}],"panels":[]}]},"httpPath":"/gateway_integrations"},{"label":"List Gateway Integrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/gateway-integrations/listgatewayintegrations","routeSlug":"/api/gateway-integrations/listgatewayintegrations","metadata":{"seo":{"title":"List Gateway Integrations","description":"Retrieve a list of Gateway Integration resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGatewayIntegrations","name":"List Gateway Integrations","isWebhook":false,"pointer":"/paths/~1gateway_integrations/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Gateway Integrations","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"linked_to","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter the list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects to show only those linked to the provided "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"MUeg77opgdgQpwejzC9wCNmK"},{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant_identity_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"IDhC29dXMAkbmr1aBpS91Hpx"},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1gateway_integrations/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1gateway_integrations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gateway_integrations","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"linked_to","in":"query","required":true,"example":"MUeg77opgdgQpwejzC9wCNmK","schemaId":"schema_6"},{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant_identity_id","in":"query","example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_6"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/gateway_integrations","href":"gateway-integrations/listgatewayintegrations","openApiOperationId":"listGatewayIntegrations","summary":"List Gateway Integrations"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/gateway_integrations?linked_to=MUeg77opgdgQpwejzC9wCNmK\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_169","exampleIds":["paths/~1gateway_integrations/get/responses/200/content/application~1json/examples/List of Gateway Integrations"]}},"schemaId":"schema_169","exampleIds":["paths/~1gateway_integrations/get/responses/200/content/application~1json/examples/List of Gateway Integrations"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1gateway_integrations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_169","exampleIds":["paths/~1gateway_integrations/get/responses/200/content/application~1json/examples/List of Gateway Integrations"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_169","exampleIds":["paths/~1gateway_integrations/get/responses/200/content/application~1json/examples/List of Gateway Integrations"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gateway-integrations/listgatewayintegrations"}],"panels":[]}]},"httpPath":"/gateway_integrations"},{"label":"Fetch a Gateway Integration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/gateway-integrations/getgatewayintegration","routeSlug":"/api/gateway-integrations/getgatewayintegration","metadata":{"seo":{"title":"Fetch a Gateway Integration","description":"Retrieve the details of an existing Gateway Integration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGatewayIntegration","name":"Fetch a Gateway Integration","isWebhook":false,"pointer":"/paths/~1gateway_integrations~1{gateway_integration_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Gateway Integration","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"gateway_integration_id","in":"path","schemaId":"schema_6","description":[{"$$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":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"gateway_integration_TBamsYxqr1KSnT4U2x9SP"}],"pointer":"/paths/~1gateway_integrations~1{gateway_integration_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1gateway_integrations~1{gateway_integration_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gateway_integrations/{gateway_integration_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"gateway_integration_id","in":"path","required":true,"example":"gateway_integration_TBamsYxqr1KSnT4U2x9SP","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/gateway_integrations/{gateway_integration_id}","href":"gateway-integrations/getgatewayintegration","openApiOperationId":"getGatewayIntegration","summary":"Fetch a Gateway Integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayIntegration","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/200/content/application~1json/examples/Gateway Integration"]}},"schemaId":"components/schemas/GatewayIntegration","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/200/content/application~1json/examples/Gateway Integration"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1gateway_integrations~1{gateway_integration_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GatewayIntegration","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/200/content/application~1json/examples/Gateway Integration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayIntegration","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/200/content/application~1json/examples/Gateway Integration"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gateway-integrations/getgatewayintegration"}],"panels":[]}]},"httpPath":"/gateway_integrations/{gateway_integration_id}"}],"content":{"contentType":"group","meta":{"name":"Gateway Integrations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gateway Integrations","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents a connection to a third-party payment gateway. At this time, the only supported gateway is Cybersource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cybersource is a Visa-owned payment gateway that integrates with Finix to provide secure payment processing and fraud management. Finix handles merchant onboarding and payouts through a unified API, while Cybersource manages gateway routing and fraud prevention for global card acceptance."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/gateway_integrations","summary":"Create a Gateway Integration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gateway-integrations/creategatewayintegration","deprecated":false},{"title":"/gateway_integrations","summary":"List Gateway Integrations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gateway-integrations/listgatewayintegrations","deprecated":false},{"title":"/gateway_integrations/{gateway_integration_id}","summary":"Fetch a Gateway Integration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gateway-integrations/getgatewayintegration","deprecated":false}]}]}]}]}},{"type":"group","label":"Receipts","link":"/api/receipts","routeSlug":"/api/receipts","items":[{"label":"Create a Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/receipts/createreceipt","routeSlug":"/api/receipts/createreceipt","metadata":{"seo":{"title":"Create a Receipt","description":"Create a Receipt resource to generate a receipt for aTransfer or Authorization. Receipts aresupported for DEBIT and REVERSAL transfers, as well as CREDIT transfersfrom unreferenced refunds."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createReceipt","name":"Create a Receipt","isWebhook":false,"pointer":"/paths/~1receipts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a 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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource to generate a receipt for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Authorizations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Receipts are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transfers, as well as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transfers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds#unreferenced-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unreferenced refunds"},"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":"Include basic details such as total amount, buyer billing information, merchant"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"name, and contact info."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally, provide:"},"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_breakdown"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of charges like subtotal, shipping, and surcharges"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list with product name, description, price, and quantity"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customization_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for structured data in the receipt header ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subheader_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and free-form text arrays above or below the receipt line items ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"summary_sections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"footer_sections"},"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":"code","inline":true,"attributes":{"content":"additional_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as an array of key-value pairs to capture extra metadata, such as \"Invoice Number\" or \"Service Date\". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customization_details.subheader_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1receipts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - All Fields"]}},"schemaId":"schema_170","exampleIds":["paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - All Fields"],"pointer":"/paths/~1receipts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/receipts","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - All Fields"]}},"responseCodes":["201","400","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/receipts","href":"receipts/createreceipt","openApiOperationId":"createReceipt","summary":"Create a Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_170","exampleIds":["paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - All Fields"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_170","exampleIds":["paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - All Fields"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Receipt","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/receipt","exampleIds":["paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - All Fields"]}},"schemaId":"components/schemas/receipt","exampleIds":["paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - All Fields"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/422/content/application~1json/examples/Unsupported transfer type"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/422/content/application~1json/examples/Unsupported transfer type"]}],"pointer":"/paths/~1receipts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/receipt","exampleIds":["paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - All Fields"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/receipt","exampleIds":["paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - Minimal Fields","paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - All Fields"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/422/content/application~1json/examples/Unsupported transfer type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts/post/responses/422/content/application~1json/examples/Unsupported transfer type"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/receipts/createreceipt"}],"panels":[]}]},"httpPath":"/receipts"},{"label":"Fetch a Receipt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/receipts/getreceipt","routeSlug":"/api/receipts/getreceipt","metadata":{"seo":{"title":"Fetch a Receipt","description":"Retrieve the details of an existing Receipt."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReceipt","name":"Fetch a Receipt","isWebhook":false,"pointer":"/paths/~1receipts~1{receipt_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a 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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"receipt_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"receipt_cE9rPGb6fxVmy7uzWQZDx"}],"pointer":"/paths/~1receipts~1{receipt_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1receipts~1{receipt_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/receipts/{receipt_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"receipt_id","in":"path","required":true,"example":"receipt_cE9rPGb6fxVmy7uzWQZDx","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/receipts/{receipt_id}","href":"receipts/getreceipt","openApiOperationId":"getReceipt","summary":"Fetch a Receipt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/receipt","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/200/content/application~1json/examples/Receipt"]}},"schemaId":"components/schemas/receipt","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/200/content/application~1json/examples/Receipt"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/404/content/application~1json/examples/NotFound"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/404/content/application~1json/examples/NotFound"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1receipts~1{receipt_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/receipt","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/200/content/application~1json/examples/Receipt"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/receipt","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/200/content/application~1json/examples/Receipt"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/404/content/application~1json/examples/NotFound"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/404/content/application~1json/examples/NotFound"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/receipts/getreceipt"}],"panels":[]}]},"httpPath":"/receipts/{receipt_id}"},{"label":"Create a Delivery Attempt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/receipts/createreceiptdeliveryattempt","routeSlug":"/api/receipts/createreceiptdeliveryattempt","metadata":{"seo":{"title":"Create a Delivery Attempt","description":"Create a Delivery Attempt on an existing Receipt resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createReceiptDeliveryAttempt","name":"Create a Delivery Attempt","isWebhook":false,"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Delivery Attempt","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"receipt_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"receipt_cE9rPGb6fxVmy7uzWQZDx"}],"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createReceiptDeliveryAttempt","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/requestBody/content/application~1json/examples/Delivery Attempt"]}},"schemaId":"components/schemas/createReceiptDeliveryAttempt","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/requestBody/content/application~1json/examples/Delivery Attempt"],"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/receipts/{receipt_id}/delivery_attempts","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"receipt_id","in":"path","required":true,"example":"receipt_cE9rPGb6fxVmy7uzWQZDx","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createReceiptDeliveryAttempt","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/requestBody/content/application~1json/examples/Delivery Attempt"]}},"responseCodes":["202","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/receipts/{receipt_id}/delivery_attempts","href":"receipts/createreceiptdeliveryattempt","openApiOperationId":"createReceiptDeliveryAttempt","summary":"Create a Delivery Attempt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createReceiptDeliveryAttempt","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/requestBody/content/application~1json/examples/Delivery Attempt"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createReceiptDeliveryAttempt","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/requestBody/content/application~1json/examples/Delivery Attempt"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted. No response body is returned."},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/receipts/createreceiptdeliveryattempt"}],"panels":[]}]},"httpPath":"/receipts/{receipt_id}/delivery_attempts"},{"label":"List Receipt Delivery Attempts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/receipts/listreceiptdeliveryattempts","routeSlug":"/api/receipts/listreceiptdeliveryattempts","metadata":{"seo":{"title":"List Receipt Delivery Attempts","description":"List Delivery Attempts for a Receipt resource."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReceiptDeliveryAttempts","name":"List Receipt Delivery Attempts","isWebhook":false,"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Receipt Delivery Attempts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Delivery Attempts for a Receipt resource."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"receipt_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"receipt_cE9rPGb6fxVmy7uzWQZDx"}],"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."}],"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/receipts/{receipt_id}/delivery_attempts","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"receipt_id","in":"path","required":true,"example":"receipt_cE9rPGb6fxVmy7uzWQZDx","schemaId":"schema_6"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/receipts/{receipt_id}/delivery_attempts","href":"receipts/listreceiptdeliveryattempts","openApiOperationId":"listReceiptDeliveryAttempts","summary":"List Receipt Delivery Attempts"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/200/content/application~1json/examples/List of Receipt Delivery Attempts"]}},"schemaId":"schema_171","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/200/content/application~1json/examples/List of Receipt Delivery Attempts"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The syntax of the request content was correct, but the server was unable to process the contained instructions.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_171","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/200/content/application~1json/examples/List of Receipt Delivery Attempts"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_171","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/200/content/application~1json/examples/List of Receipt Delivery Attempts"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/receipts/listreceiptdeliveryattempts"}],"panels":[]}]},"httpPath":"/receipts/{receipt_id}/delivery_attempts"}],"content":{"contentType":"group","meta":{"name":"Receipts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Receipts","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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource generates a receipt for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Authorizations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorizations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can then send the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via Email, SMS, or use the information from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to send it yourself."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/sending-receipts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Receipts for Online Payments"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/receipts","summary":"Create a Receipt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/receipts/createreceipt","deprecated":false},{"title":"/receipts/{receipt_id}","summary":"Fetch a Receipt","prefix":{"name":"get","color":"get"},"badges":[],"link":"/receipts/getreceipt","deprecated":false},{"title":"/receipts/{receipt_id}/delivery_attempts","summary":"Create a Delivery Attempt","prefix":{"name":"post","color":"post"},"badges":[],"link":"/receipts/createreceiptdeliveryattempt","deprecated":false},{"title":"/receipts/{receipt_id}/delivery_attempts","summary":"List Receipt Delivery Attempts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/receipts/listreceiptdeliveryattempts","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscriptions","link":"/api/subscriptions","routeSlug":"/api/subscriptions","items":[{"label":"Create a Subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/createsubscription","routeSlug":"/api/subscriptions/createsubscription","metadata":{"seo":{"title":"Create a Subscription","description":"Create a Subscription to charge a Payment Instrument on a recurring schedule. Without a trial period, the first Transfer is created within 60 minutes of the Subscription being created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscription","name":"Create a Subscription","isWebhook":false,"pointer":"/paths/~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Subscription","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to charge a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a recurring schedule. Without a trial period, the first "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created within 60 minutes of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being created."},"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":"Optional features:"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trial period"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trial_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to delay the first charge; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_charge_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response shows when billing begins. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is based on a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trial_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not override those from the plan."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Discount phase"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount_phase_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a reduced "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_interval_count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to apply a discounted price for a set number of cycles before full billing resumes. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is based on a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount_phase_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not override the plan's values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Subscription Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - provide a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_plan_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to base the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" template (inherits "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and more). You cannot set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when you use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Future start"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a future timestamp; the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" starts in state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_STARTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_phase: NONE"},"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing cycle day"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_cycle_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to control which day of the month billing occurs for monthly-cycle subscriptions (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MONTHLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIMONTHLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUARTERLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEMIYEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIYEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRIYEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). If the start date doesn't match the billing cycle day, the first invoice is prorated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Fixed length"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to expire the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after a fixed number of billing cycles."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" › "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLE_PAY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOOGLE_PAY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Finix runs a $0.01 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to validate the card (AVS and CVV). If validation fails, the API returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not created."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"]}},"schemaId":"schema_172","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"],"pointer":"/paths/~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"]}},"responseCodes":["201","400","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscriptions","href":"subscriptions/createsubscription","openApiOperationId":"createSubscription","summary":"Create a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_172","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_172","exampleIds":["paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"]}},"examples":[{},{},{},{},{},{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Subscription","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"]}},"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. The request was well-formed but could not be processed due to a semantic error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at and total_billing_intervals conflict","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before subscription start","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before free trial end","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before discounted phase end"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at and total_billing_intervals conflict","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before subscription start","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before free trial end","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before discounted phase end"]}],"pointer":"/paths/~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Minimal Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - All Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Billing Cycle Day","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Discount Phase","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length - End Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Future Start Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Trial Period","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - All Fields","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date","paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at and total_billing_intervals conflict","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before subscription start","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before free trial end","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before discounted phase end"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at and total_billing_intervals conflict","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before subscription start","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before free trial end","paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before discounted phase end"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/createsubscription"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"List Subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/listsubscriptions","routeSlug":"/api/subscriptions/listsubscriptions","metadata":{"seo":{"title":"List Subscriptions","description":"Retrieve a list of Subscription resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptions","name":"List Subscriptions","isWebhook":false,"pointer":"/paths/~1subscriptions/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscriptions","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/query-parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"amount.gt","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than."},{"name":"amount.gte","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than or equal."},{"name":"amount.lt","in":"query","schemaId":"schema_7","description":"Filter by an amount less than."},{"name":"amount.lte","in":"query","schemaId":"schema_7","description":"Filter by an amount less than or equal."},{"name":"amount","in":"query","schemaId":"schema_7","description":"Filter by an amount equal to the given value."},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"billing_interval","in":"query","schemaId":"schema_173","description":"Filter by billing frequency."},{"name":"buyer_identity_id","in":"query","schemaId":"schema_138","description":"Filter by the Buyer Identity's ID."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"linked_to","in":"query","schemaId":"schema_174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter subscriptions linked to a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"merchant_identity_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"IDhC29dXMAkbmr1aBpS91Hpx"},{"name":"nickname","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name (exact match)."},"children":[]}]}]}]},{"name":"nickname.like","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name (partial match)."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_175","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"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":"ACTIVE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXPIRED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_STARTED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAST DUE"},"children":[]}]}]}]}]},{"name":"subscription_link_id","in":"query","schemaId":"schema_176","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter subscriptions created by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"subscription_plan_id","in":"query","schemaId":"schema_177","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter subscriptions that were created using a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"amount.gt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"billing_interval","in":"query","example":"MONTHLY","schemaId":"schema_173"},{"name":"buyer_identity_id","in":"query","example":"ID6Qm3BQUxGFcCWZ185TS8sn","schemaId":"schema_138"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"id","in":"query","schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"linked_to","in":"query","example":"MUcgYZswyRfqSSbvMsxuaHxZ","schemaId":"schema_174"},{"name":"merchant_identity_id","in":"query","example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_6"},{"name":"nickname","in":"query","schemaId":"schema_6"},{"name":"nickname.like","in":"query","schemaId":"schema_6"},{"name":"state","in":"query","example":"NOT_STARTED","schemaId":"schema_175","style":"form"},{"name":"subscription_link_id","in":"query","required":false,"example":"subscription_link_cvTp2K5CNH9Lr4BqCphcM","schemaId":"schema_176"},{"name":"subscription_plan_id","in":"query","example":"subscription_plan_ciLn19pSKDTFoehtH7ET","schemaId":"schema_177"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscriptions","href":"subscriptions/listsubscriptions","openApiOperationId":"listSubscriptions","summary":"List Subscriptions"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/subscriptions\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1subscriptions/get/responses/200/content/application~1json/examples/List of Subscriptions"]}},"schemaId":"schema_178","exampleIds":["paths/~1subscriptions/get/responses/200/content/application~1json/examples/List of Subscriptions"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_178","exampleIds":["paths/~1subscriptions/get/responses/200/content/application~1json/examples/List of Subscriptions"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_178","exampleIds":["paths/~1subscriptions/get/responses/200/content/application~1json/examples/List of Subscriptions"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/listsubscriptions"}],"panels":[]}]},"httpPath":"/subscriptions"},{"label":"Fetch a Subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/getsubscription","routeSlug":"/api/subscriptions/getsubscription","metadata":{"seo":{"title":"Fetch a Subscription","description":"Retrieve the details of a previously created Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscription","name":"Fetch a Subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Subscription","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":"text","inline":true,"attributes":{"content":"Retrieve the details of a previously created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_179","description":[{"$$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":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6"}],"pointer":"/paths/~1subscriptions~1{subscription_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{subscription_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{subscription_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6","schemaId":"schema_179"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscriptions/{subscription_id}","href":"subscriptions/getsubscription","openApiOperationId":"getSubscription","summary":"Fetch a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/200/content/application~1json/examples/Subscription"]}},"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/200/content/application~1json/examples/Subscription"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscriptions~1{subscription_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/200/content/application~1json/examples/Subscription"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/200/content/application~1json/examples/Subscription"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/getsubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Update Subscription","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/updatesubscription","routeSlug":"/api/subscriptions/updatesubscription","metadata":{"seo":{"title":"Update Subscription","description":"Update an existing Subscription resource, typically used for subscriptions created without a Subscription Plan. Note that you can only update specific resource fields."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscription","name":"Update Subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Subscription","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":"text","inline":true,"attributes":{"content":"Update an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource, typically used for subscriptions created without a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Note that you can only update specific resource fields."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Common use cases for updating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" include:"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscriptions/updatesubscription/request/updating-the-payment-amount","deepLinkHash":"/subscriptions/updatesubscription#subscriptions/updatesubscription/request/updating-the-payment-amount"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating the payment amount"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation allows for adjusting the payment amount, such as when a subscriber decides to donate more or less money to a charity or upgrade/downgrade a product or service."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscriptions/updatesubscription/request/updating-billing-details","deepLinkHash":"/subscriptions/updatesubscription#subscriptions/updatesubscription/request/updating-billing-details"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating billing details"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the subscriber wishes to change their payment details, you can update the ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_details.instrument_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"] property with a new "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Payment-Instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"subscriptions/updatesubscription/request/updating-the-billing-cycle-day","deepLinkHash":"/subscriptions/updatesubscription#subscriptions/updatesubscription/request/updating-the-billing-cycle-day"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating the billing cycle day"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_cycle_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to change the day of the month the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" bills. Invoices that have already been issued do not change, and the current billing period completes at the full amount. On the next billing date, the buyer is charged a prorated amount that bridges the gap to the new billing cycle day, then full billing resumes. To learn more, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/subscriptions/subscriptions-quickstart#billing-cycle-day"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Billing cycle day"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_179","description":[{"$$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":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6"}],"pointer":"/paths/~1subscriptions~1{subscription_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - New Subscription Plan"]}},"schemaId":"schema_180","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - New Subscription Plan"],"pointer":"/paths/~1subscriptions~1{subscription_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/subscriptions/{subscription_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6","schemaId":"schema_179"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - New Subscription Plan"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscriptions/{subscription_id}","href":"subscriptions/updatesubscription","openApiOperationId":"updateSubscription","summary":"Update Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_180","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - New Subscription Plan"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_180","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - New Subscription Plan"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - New Subscription Plan"]}},"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - New Subscription Plan"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscriptions~1{subscription_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - New Subscription Plan"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription","paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - Billing Cycle Day","paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - New Subscription Plan"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/updatesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Cancel a Subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/removesubscription","routeSlug":"/api/subscriptions/removesubscription","metadata":{"seo":{"title":"Cancel a Subscription","description":"Cancel a Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeSubscription","name":"Cancel a Subscription","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel a Subscription","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":"text","inline":true,"attributes":{"content":"Cancel a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_179","description":[{"$$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":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}],"required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6"}],"pointer":"/paths/~1subscriptions~1{subscription_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{subscription_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subscriptions/{subscription_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6","schemaId":"schema_179"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["204","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscriptions/{subscription_id}","href":"subscriptions/removesubscription","openApiOperationId":"removeSubscription","summary":"Cancel a Subscription"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Deleted. No resource to return."},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscriptions~1{subscription_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}/delete/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/removesubscription"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}"},{"label":"Create a Subscription Balance Entry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/createsubscriptionbalanceentry","routeSlug":"/api/subscriptions/createsubscriptionbalanceentry","metadata":{"seo":{"title":"Create a Subscription Balance Entry","description":"Create a Subscription Balance Entry. A Subscription Balance Entry represents a credit applied to a Subscription."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscriptionBalanceEntry","name":"Create a Subscription Balance Entry","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Subscription Balance Entry","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represents a credit applied to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_179","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6"}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createSubscriptionBalanceEntry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/requestBody/content/application~1json/examples/Subscription Balance Entry"]}},"schemaId":"components/schemas/createSubscriptionBalanceEntry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/requestBody/content/application~1json/examples/Subscription Balance Entry"],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscriptions/{subscription_id}/subscription_balance_entries","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6","schemaId":"schema_179"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createSubscriptionBalanceEntry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/requestBody/content/application~1json/examples/Subscription Balance Entry"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscriptions/{subscription_id}/subscription_balance_entries","href":"subscriptions/createsubscriptionbalanceentry","openApiOperationId":"createSubscriptionBalanceEntry","summary":"Create a Subscription Balance Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createSubscriptionBalanceEntry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/requestBody/content/application~1json/examples/Subscription Balance Entry"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createSubscriptionBalanceEntry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/requestBody/content/application~1json/examples/Subscription Balance Entry"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Subscription Balance Entry","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_balance_entry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/201/content/application~1json/examples/Subscription Balance Entry"]}},"schemaId":"components/schemas/subscription_balance_entry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/201/content/application~1json/examples/Subscription Balance Entry"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/subscription_balance_entry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/201/content/application~1json/examples/Subscription Balance Entry"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_balance_entry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/201/content/application~1json/examples/Subscription Balance Entry"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/createsubscriptionbalanceentry"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}/subscription_balance_entries"},{"label":"List Subscription Balance Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/listsubscriptionbalanceentries","routeSlug":"/api/subscriptions/listsubscriptionbalanceentries","metadata":{"seo":{"title":"List Subscription Balance Entries","description":"Retrieve a list of Subscription Balance Entry resources to view a timeline of all changes to a Subscription balance by a user. Currently, only credits can modify a Subscription balance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptionBalanceEntries","name":"List Subscription Balance Entries","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscription Balance Entries","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources to view a timeline of all changes to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" balance by a user. Currently, only credits can modify a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/overview/#section/Query-Parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_179","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6"}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"amount","in":"query","schemaId":"schema_7","description":"Filter by an amount equal to the given value."},{"name":"amount.gt","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than."},{"name":"amount.gte","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than or equal."},{"name":"amount.lt","in":"query","schemaId":"schema_7","description":"Filter by an amount less than."},{"name":"amount.lte","in":"query","schemaId":"schema_7","description":"Filter by an amount less than or equal."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"merchant_identity_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"IDhC29dXMAkbmr1aBpS91Hpx"},{"name":"sort","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the key to be used for sorting the collection. Acceptable values are:"},"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":"updated_at"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_at"},"children":[]}]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscriptions/{subscription_id}/subscription_balance_entries","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6","schemaId":"schema_179"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"amount","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"merchant_identity_id","in":"query","example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_6"},{"name":"sort","in":"query","schemaId":"schema_6","style":"form"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscriptions/{subscription_id}/subscription_balance_entries","href":"subscriptions/listsubscriptionbalanceentries","openApiOperationId":"listSubscriptionBalanceEntries","summary":"List Subscription Balance Entries"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_181","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/200/content/application~1json/examples/List of Subscription Balance Entries"]}},"schemaId":"schema_181","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/200/content/application~1json/examples/List of Subscription Balance Entries"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_181","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/200/content/application~1json/examples/List of Subscription Balance Entries"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_181","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/200/content/application~1json/examples/List of Subscription Balance Entries"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/listsubscriptionbalanceentries"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}/subscription_balance_entries"},{"label":"Update Subscription Balance Entry","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscriptions/updatesubscriptionbalanceentry","routeSlug":"/api/subscriptions/updatesubscriptionbalanceentry","metadata":{"seo":{"title":"Update Subscription Balance Entry","description":"Update the tags for an existing Subscription Balance Entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscriptionBalanceEntry","name":"Update Subscription Balance Entry","isWebhook":false,"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Subscription Balance Entry","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":"text","inline":true,"attributes":{"content":"Update the tags for an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_id","in":"path","schemaId":"schema_179","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6"},{"name":"subscription_balance_entry_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateSubscriptionBalanceEntry"}},"schemaId":"components/schemas/updateSubscriptionBalanceEntry","pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/subscriptions/{subscription_id}/subscription_balance_entries/{subscription_balance_entry_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_id","in":"path","required":true,"example":"subscription_cvTpAt87A4hncnuC4rkh6","schemaId":"schema_179"},{"name":"subscription_balance_entry_id","in":"path","required":true,"schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/updateSubscriptionBalanceEntry"}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscriptions/{subscription_id}/subscription_balance_entries/{subscription_balance_entry_id}","href":"subscriptions/updatesubscriptionbalanceentry","openApiOperationId":"updateSubscriptionBalanceEntry","summary":"Update Subscription Balance Entry"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries/subscription_balance_entry_czM1i9keffyXNVr3J9TzA\" \\\n  -H \"Content-Type: application/json\" \\\n  -H \"Finix-Version: 2022-02-01\" \\\n  -u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda \\\n  -X PUT \\\n  -d '\n  {\n    \"tags\": {\n      \"internal_code\": \"1234E\"\n    }\n  }'\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/updateSubscriptionBalanceEntry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/updateSubscriptionBalanceEntry"}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Balance Entry"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_balance_entry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/200/content/application~1json/examples/Subscription Balance Entry"]}},"schemaId":"components/schemas/subscription_balance_entry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/200/content/application~1json/examples/Subscription Balance Entry"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_balance_entry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/200/content/application~1json/examples/Subscription Balance Entry"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_balance_entry","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/200/content/application~1json/examples/Subscription Balance Entry"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscriptions/updatesubscriptionbalanceentry"}],"panels":[]}]},"httpPath":"/subscriptions/{subscription_id}/subscription_balance_entries/{subscription_balance_entry_id}"}],"content":{"contentType":"group","meta":{"name":"Subscriptions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscriptions","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents a recurring charge to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at regular intervals. Subscribers can be buyers, customers, or merchants."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscriptions are supported for USA and Canadian merchants."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you have the option to use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"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":"Limitations"},"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":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported countries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Subscriptions are available in the United States and Canada."},"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":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported payment methods"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Subscriptions currently support recurring card payments and recurring bank account payments ("},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"a","attrs":{"href":"/guides/online-payments/bank-payments/ach-direct-debits"}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the USA)."},"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":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved merchants"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": At this time, only approved merchants with one of the following processors can create subscriptions: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"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":"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":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/subscriptions/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating Subscription Plans"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/subscriptions/recurring-payment-guidelines"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring Payments Guidelines"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscriptions","summary":"Create a Subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/createsubscription","deprecated":false},{"title":"/subscriptions","summary":"List Subscriptions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/listsubscriptions","deprecated":false},{"title":"/subscriptions/{subscription_id}","summary":"Fetch a Subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/getsubscription","deprecated":false},{"title":"/subscriptions/{subscription_id}","summary":"Update Subscription","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/updatesubscription","deprecated":false},{"title":"/subscriptions/{subscription_id}","summary":"Cancel a Subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subscriptions/removesubscription","deprecated":false},{"title":"/subscriptions/{subscription_id}/subscription_balance_entries","summary":"Create a Subscription Balance Entry","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscriptions/createsubscriptionbalanceentry","deprecated":false},{"title":"/subscriptions/{subscription_id}/subscription_balance_entries","summary":"List Subscription Balance Entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscriptions/listsubscriptionbalanceentries","deprecated":false},{"title":"/subscriptions/{subscription_id}/subscription_balance_entries/{subscription_balance_entry_id}","summary":"Update Subscription Balance Entry","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscriptions/updatesubscriptionbalanceentry","deprecated":false}]}]}]}]}},{"type":"group","label":"Subscription Plans","link":"/api/subscription-plans","routeSlug":"/api/subscription-plans","items":[{"label":"Create a Subscription Plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscription-plans/createsubscriptionplan","routeSlug":"/api/subscription-plans/createsubscriptionplan","metadata":{"seo":{"title":"Create a Subscription Plan","description":"Create a Subscription Plan resource to group and manage recurring payments for individual Subscription resources. You can create a Subscription Plan with or without a trial period."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscriptionPlan","name":"Create a Subscription Plan","isWebhook":false,"pointer":"/paths/~1subscription_plans/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Subscription Plan","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource to group and manage recurring payments for individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources. You can create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with or without a trial period."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscription_plans/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_182","exampleIds":["paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Trial Phase"]}},"schemaId":"schema_182","exampleIds":["paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Trial Phase"],"pointer":"/paths/~1subscription_plans/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subscription_plans","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_182","exampleIds":["paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Trial Phase"]}},"responseCodes":["201","400","401","403","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscription_plans","href":"subscription-plans/createsubscriptionplan","openApiOperationId":"createSubscriptionPlan","summary":"Create a Subscription Plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_182","exampleIds":["paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Trial Phase"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_182","exampleIds":["paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Trial Phase"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Subscription Plan","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Trial Phase"]}},"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Trial Phase"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscription_plans/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Trial Phase"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Default Duration","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Discount Phase","paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Trial Phase"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/post/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-plans/createsubscriptionplan"}],"panels":[]}]},"httpPath":"/subscription_plans"},{"label":"List Subscription Plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscription-plans/listsubscriptionplans","routeSlug":"/api/subscription-plans/listsubscriptionplans","metadata":{"seo":{"title":"List Subscription Plans","description":"Retrieve a list of Subscription Plan resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptionPlans","name":"List Subscription Plans","isWebhook":false,"pointer":"/paths/~1subscription_plans/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Subscription Plans","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"amount.gt","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than."},{"name":"amount.gte","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than or equal."},{"name":"amount.lt","in":"query","schemaId":"schema_7","description":"Filter by an amount less than."},{"name":"amount.lte","in":"query","schemaId":"schema_7","description":"Filter by an amount less than or equal."},{"name":"amount","in":"query","schemaId":"schema_7","description":"Filter by an amount equal to the given value."},{"name":"linked_to","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter subscription plans linked to a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},{"name":"merchant_identity_id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"IDhC29dXMAkbmr1aBpS91Hpx"},{"name":"plan_name","in":"query","schemaId":"schema_6","description":"Filter by the plan name (exact match)."},{"name":"plan_name.like","in":"query","schemaId":"schema_6","description":"Filter by the plan name (partial match)."},{"name":"state","in":"query","schemaId":"schema_183","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"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":"text","inline":true,"attributes":{"content":"ACTIVE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INACTIVE"},"children":[]}]}]}]}]},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1subscription_plans/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscription_plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription_plans","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"amount.gt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"linked_to","in":"query","required":false,"example":"MUcgYZswyRfqSSbvMsxuaHxZ","schemaId":"schema_6"},{"name":"merchant_identity_id","in":"query","example":"IDhC29dXMAkbmr1aBpS91Hpx","schemaId":"schema_6"},{"name":"plan_name","in":"query","schemaId":"schema_6"},{"name":"plan_name.like","in":"query","schemaId":"schema_6"},{"name":"state","in":"query","example":"INACTIVE","schemaId":"schema_183","style":"form"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"},{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscription_plans","href":"subscription-plans/listsubscriptionplans","openApiOperationId":"listSubscriptionPlans","summary":"List Subscription Plans"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/subscription_plans\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184","exampleIds":["paths/~1subscription_plans/get/responses/200/content/application~1json/examples/List of Subscription Plans"]}},"schemaId":"schema_184","exampleIds":["paths/~1subscription_plans/get/responses/200/content/application~1json/examples/List of Subscription Plans"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1subscription_plans/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_184","exampleIds":["paths/~1subscription_plans/get/responses/200/content/application~1json/examples/List of Subscription Plans"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_184","exampleIds":["paths/~1subscription_plans/get/responses/200/content/application~1json/examples/List of Subscription Plans"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-plans/listsubscriptionplans"}],"panels":[]}]},"httpPath":"/subscription_plans"},{"label":"Fetch a Subscription Plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscription-plans/getsubscriptionplan","routeSlug":"/api/subscription-plans/getsubscriptionplan","metadata":{"seo":{"title":"Fetch a Subscription Plan","description":"Retrieve the details of an existing Subscription Plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubscriptionPlan","name":"Fetch a Subscription Plan","isWebhook":false,"pointer":"/paths/~1subscription_plans~1{subscription_plan_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Subscription Plan","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_plan_id","in":"path","schemaId":"schema_185","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"subscription_plan_ciLn19pSKDTFoehtH7ETg"}],"pointer":"/paths/~1subscription_plans~1{subscription_plan_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1subscription_plans~1{subscription_plan_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subscription_plans/{subscription_plan_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_plan_id","in":"path","required":true,"example":"subscription_plan_ciLn19pSKDTFoehtH7ETg","schemaId":"schema_185"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscription_plans/{subscription_plan_id}","href":"subscription-plans/getsubscriptionplan","openApiOperationId":"getSubscriptionPlan","summary":"Fetch a Subscription Plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/200/content/application~1json/examples/Subscription Plan"]}},"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/200/content/application~1json/examples/Subscription Plan"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscription_plans~1{subscription_plan_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/200/content/application~1json/examples/Subscription Plan"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/200/content/application~1json/examples/Subscription Plan"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-plans/getsubscriptionplan"}],"panels":[]}]},"httpPath":"/subscription_plans/{subscription_plan_id}"},{"label":"Update Subscription Plan","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/subscription-plans/updatesubscriptionplan","routeSlug":"/api/subscription-plans/updatesubscriptionplan","metadata":{"seo":{"title":"Update Subscription Plan","description":"Update an existing Subscription Plan."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubscriptionPlan","name":"Update Subscription Plan","isWebhook":false,"pointer":"/paths/~1subscription_plans~1{subscription_plan_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Subscription Plan","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":"text","inline":true,"attributes":{"content":"Update an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"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":"Options:"},"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":"Set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_existing_subscriptions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update existing subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Archive the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by setting its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"subscription_plan_id","in":"path","schemaId":"schema_185","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"subscription_plan_ciLn19pSKDTFoehtH7ETg"}],"pointer":"/paths/~1subscription_plans~1{subscription_plan_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_186","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Deactivate Subscription Plan"]}},"schemaId":"schema_186","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Deactivate Subscription Plan"],"pointer":"/paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/subscription_plans/{subscription_plan_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"subscription_plan_id","in":"path","required":true,"example":"subscription_plan_ciLn19pSKDTFoehtH7ETg","schemaId":"schema_185"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_186","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Deactivate Subscription Plan"]}},"responseCodes":["200","400","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/subscription_plans/{subscription_plan_id}","href":"subscription-plans/updatesubscriptionplan","openApiOperationId":"updateSubscriptionPlan","summary":"Update Subscription Plan"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"schema_186","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Deactivate Subscription Plan"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_186","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Deactivate Subscription Plan"]}},"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Deactivate Subscription Plan"]}},"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Deactivate Subscription Plan"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1subscription_plans~1{subscription_plan_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Deactivate Subscription Plan"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/subscription_plan","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Update Subscription Plan","paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Deactivate Subscription Plan"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1subscription_plans~1{subscription_plan_id}/put/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subscription-plans/updatesubscriptionplan"}],"panels":[]}]},"httpPath":"/subscription_plans/{subscription_plan_id}"}],"content":{"contentType":"group","meta":{"name":"Subscription Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subscription Plans","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is a template with set recurring costs and frequencies that can be reused across multiple "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/subscriptions/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating Subscriptions Plans"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/subscriptions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating Subscriptions"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/subscriptions/recurring-payment-guidelines"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring Payments Guidelines"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subscription_plans","summary":"Create a Subscription Plan","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subscription-plans/createsubscriptionplan","deprecated":false},{"title":"/subscription_plans","summary":"List Subscription Plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-plans/listsubscriptionplans","deprecated":false},{"title":"/subscription_plans/{subscription_plan_id}","summary":"Fetch a Subscription Plan","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subscription-plans/getsubscriptionplan","deprecated":false},{"title":"/subscription_plans/{subscription_plan_id}","summary":"Update Subscription Plan","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subscription-plans/updatesubscriptionplan","deprecated":false}]}]}]}]}},{"type":"group","label":"Transfer Attempts","link":"/api/transfer-attempts","routeSlug":"/api/transfer-attempts","items":[{"label":"List Transfer Attempts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfer-attempts/listtransferattempts","routeSlug":"/api/transfer-attempts/listtransferattempts","metadata":{"seo":{"title":"List Transfer Attempts","description":"Retrieve a list of all Transfer Attempt resources, or filter the results to a specific Checkout Form, Payment Link, and Payout Link using the entity_id query parameter."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransferAttempts","name":"List Transfer Attempts","isWebhook":false,"pointer":"/paths/~1transfer_attempts/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Transfer Attempts","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":"text","inline":true,"attributes":{"content":"Retrieve a list of all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources, or filter the results to a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checkout Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"amount","in":"query","schemaId":"schema_7","description":"Filter by an amount equal to the given value."},{"name":"amount.gt","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than."},{"name":"amount.gte","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than or equal."},{"name":"amount.lt","in":"query","schemaId":"schema_7","description":"Filter by an amount less than."},{"name":"amount.lte","in":"query","schemaId":"schema_7","description":"Filter by an amount less than or equal."},{"name":"application_id","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"authorization_id","in":"query","schemaId":"schema_187","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"buyer_email","in":"query","schemaId":"schema_188","description":"Filter by the buyer's email address (exact match)."},{"name":"buyer_email.like","in":"query","schemaId":"schema_142","description":"Filter by the buyer's email address (partial match)."},{"name":"buyer_first_name","in":"query","schemaId":"schema_21","description":"Filter by the buyer's first name (exact match)."},{"name":"buyer_first_name.like","in":"query","schemaId":"schema_137","description":"Filter by the buyer's first name (partial match)."},{"name":"buyer_last_name","in":"query","schemaId":"schema_139","description":"Filter by the buyer's last name (exact match)."},{"name":"buyer_last_name.like","in":"query","schemaId":"schema_140","description":"Filter by the buyer's last name (partial match)."},{"name":"entity_id","in":"query","schemaId":"schema_189","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checkout Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"entity_type","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":"Filter by the type of entity that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"is_authorization","in":"query","schemaId":"schema_34","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is tied to an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"merchant_id","in":"query","schemaId":"schema_20","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"payment_instrument_id","in":"query","schemaId":"schema_96","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"state","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":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}]},{"name":"transfer_id","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":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"id","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1transfer_attempts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transfer_attempts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfer_attempts","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"amount","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"application_id","in":"query","example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_33"},{"name":"authorization_id","in":"query","example":"AUogt3PgskE2ahBFmTpn2EGJ","schemaId":"schema_187"},{"name":"buyer_email","in":"query","example":"john@example.com","schemaId":"schema_188"},{"name":"buyer_email.like","in":"query","example":"john","schemaId":"schema_142"},{"name":"buyer_first_name","in":"query","example":"John","schemaId":"schema_21"},{"name":"buyer_first_name.like","in":"query","example":"joh","schemaId":"schema_137"},{"name":"buyer_last_name","in":"query","example":"Doe","schemaId":"schema_139"},{"name":"buyer_last_name.like","in":"query","example":"do","schemaId":"schema_140"},{"name":"entity_id","in":"query","example":"checkout_form_ciADaDNMFAHdyNbDPuByS","schemaId":"schema_189"},{"name":"entity_type","in":"query","example":"PAYMENT_LINK","schemaId":"schema_190"},{"name":"is_authorization","in":"query","example":true,"schemaId":"schema_34"},{"name":"merchant_id","in":"query","example":"MUeDVrf2ahuKc9Eg5TeZugvs","schemaId":"schema_20"},{"name":"payment_instrument_id","in":"query","example":"PIcgYZswyRfqSSbvMsxuaHxZ","schemaId":"schema_96"},{"name":"state","in":"query","example":"SUCCEEDED","schemaId":"schema_191"},{"name":"transfer_id","in":"query","example":"TRnH7FkSB7zePeHExNZwSb9H","schemaId":"schema_192"},{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"id","in":"query","schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/transfer_attempts","href":"transfer-attempts/listtransferattempts","openApiOperationId":"listTransferAttempts","summary":"List Transfer Attempts"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/transfer_attempts\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1transfer_attempts/get/responses/200/content/application~1json/examples/List of Transfer Attempts"]}},"schemaId":"schema_193","exampleIds":["paths/~1transfer_attempts/get/responses/200/content/application~1json/examples/List of Transfer Attempts"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1transfer_attempts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_193","exampleIds":["paths/~1transfer_attempts/get/responses/200/content/application~1json/examples/List of Transfer Attempts"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_193","exampleIds":["paths/~1transfer_attempts/get/responses/200/content/application~1json/examples/List of Transfer Attempts"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-attempts/listtransferattempts"}],"panels":[]}]},"httpPath":"/transfer_attempts"},{"label":"Fetch a Transfer Attempt","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/transfer-attempts/gettransferattempt","routeSlug":"/api/transfer-attempts/gettransferattempt","metadata":{"seo":{"title":"Fetch a Transfer Attempt","description":"Retrieve the details of a Transfer Attempt initiated from a Checkout Form, Payment Link or Payout Link."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransferAttempt","name":"Fetch a Transfer Attempt","isWebhook":false,"pointer":"/paths/~1transfer_attempts~1{transfer_attempt_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Transfer Attempt","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":"text","inline":true,"attributes":{"content":"Retrieve the details of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" initiated from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checkout Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"transfer_attempt_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"transfer_attempt_ciACBK59kDhfx2Mi4Vy81"}],"pointer":"/paths/~1transfer_attempts~1{transfer_attempt_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1transfer_attempts~1{transfer_attempt_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/transfer_attempts/{transfer_attempt_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"transfer_attempt_id","in":"path","required":true,"example":"transfer_attempt_ciACBK59kDhfx2Mi4Vy81","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/transfer_attempts/{transfer_attempt_id}","href":"transfer-attempts/gettransferattempt","openApiOperationId":"getTransferAttempt","summary":"Fetch a Transfer Attempt"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Checkout Form","paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payment Link","paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payout Link"]}},"schemaId":"schema_194","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Checkout Form","paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payment Link","paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payout Link"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/404/content/application~1json/examples/Not Found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/404/content/application~1json/examples/Not Found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_194","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Checkout Form","paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payment Link","paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payout Link"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_194","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Checkout Form","paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payment Link","paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payout Link"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/404/content/application~1json/examples/Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/404/content/application~1json/examples/Not Found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transfer-attempts/gettransferattempt"}],"panels":[]}]},"httpPath":"/transfer_attempts/{transfer_attempt_id}"}],"content":{"contentType":"group","meta":{"name":"Transfer Attempts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transfer Attempts","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":"When a user attempts to make a payment using a Checkout Form or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/low-code-no-code/payment-links"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or a recipient submitting details with a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/payout-links"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payout Link"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"—a Transfer Attempt is created."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Using transfer attempts, you can track the lifecycle of a payment or a series of payments if you are using a multi-use Payment Link."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checkout Forms and Payment Links support authorizations. If a payment made with them is an authorization, the Transfer Attempt result shows "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_authorization: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and references the authorization ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorization_id"},"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":"Each Transfer Attempt has as reference to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to allow you to query it for additional data."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/low-code-no-code/manage-low-code-no-code/transfer-attempts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer Attempts"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/transfer_attempts","summary":"List Transfer Attempts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer-attempts/listtransferattempts","deprecated":false},{"title":"/transfer_attempts/{transfer_attempt_id}","summary":"Fetch a Transfer Attempt","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transfer-attempts/gettransferattempt","deprecated":false}]}]}]}]}},{"type":"separator","label":"Payout Resources","content":null},{"type":"group","label":"Balances","link":"/api/balances","routeSlug":"/api/balances","items":[{"label":"List Balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balances/listbalances","routeSlug":"/api/balances/listbalances","metadata":{"seo":{"title":"List Balances","description":"Retrieve a list of Balance resources."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBalances","name":"List Balances","isWebhook":false,"pointer":"/paths/~1balances/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Balances","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1balances/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1balances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balances","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/balances","href":"balances/listbalances","openApiOperationId":"listBalances","summary":"List Balances"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/balances\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1balances/get/responses/200/content/application~1json/examples/List of Balances"]}},"schemaId":"schema_195","exampleIds":["paths/~1balances/get/responses/200/content/application~1json/examples/List of Balances"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1balances/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_195","exampleIds":["paths/~1balances/get/responses/200/content/application~1json/examples/List of Balances"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1balances/get/responses/200/content/application~1json/examples/List of Balances"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/listbalances"}],"panels":[]}]},"httpPath":"/balances"},{"label":"Fetch a Balance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balances/getbalance","routeSlug":"/api/balances/getbalance","metadata":{"seo":{"title":"Fetch a Balance","description":"Retrieve the details of an existing Balance."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBalance","name":"Fetch a Balance","isWebhook":false,"pointer":"/paths/~1balances~1{balance_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Balance","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":"text","inline":true,"attributes":{"content":"Retrieve the details of an existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"balance_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"balance_dyz5APsJebDef9oTW9J2Hc"}],"pointer":"/paths/~1balances~1{balance_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1balances~1{balance_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balances/{balance_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"balance_id","in":"path","required":true,"example":"balance_dyz5APsJebDef9oTW9J2Hc","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/balances/{balance_id}","href":"balances/getbalance","openApiOperationId":"getBalance","summary":"Fetch a Balance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balance","exampleIds":["paths/~1balances~1{balance_id}/get/responses/200/content/application~1json/examples/Balance"]}},"schemaId":"components/schemas/balance","exampleIds":["paths/~1balances~1{balance_id}/get/responses/200/content/application~1json/examples/Balance"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1balances~1{balance_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/balance","exampleIds":["paths/~1balances~1{balance_id}/get/responses/200/content/application~1json/examples/Balance"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balance","exampleIds":["paths/~1balances~1{balance_id}/get/responses/200/content/application~1json/examples/Balance"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/getbalance"}],"panels":[]}]},"httpPath":"/balances/{balance_id}"},{"label":"List Balance Entries","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balances/listbalanceentries","routeSlug":"/api/balances/listbalanceentries","metadata":{"seo":{"title":"List Balance Entries","description":"A Balance Entry reflects a change to an application's Balance due to a Transfer or a Balance Adjustment (i.e., \"top-up\")."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBalanceEntries","name":"List Balance Entries","isWebhook":false,"pointer":"/paths/~1balances~1{balance_id}~1balance_entries/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Balance Entries","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":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reflects a change to an application's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" due to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., \"top-up\")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use this endpoint to obtain a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"balance_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"balance_dyz5APsJebDef9oTW9J2Hc"}],"pointer":"/paths/~1balances~1{balance_id}~1balance_entries/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"amount","in":"query","schemaId":"schema_7","description":"Filter by an amount equal to the given value."},{"name":"amount.gt","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than."},{"name":"amount.gte","in":"query","schemaId":"schema_7","description":"Filter by an amount greater than or equal."},{"name":"amount.lt","in":"query","schemaId":"schema_7","description":"Filter by an amount less than."},{"name":"amount.lte","in":"query","schemaId":"schema_7","description":"Filter by an amount less than or equal."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"entity_id","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":"Return the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" triggered by the given "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/balance-adjustments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID."},"children":[]}]}]}]},{"name":"entity_type","in":"query","schemaId":"schema_197","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by whether they were triggered by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"id","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":"Retrieve a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"parent_balance_entry_id","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":"Return the reversal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the given original "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID. When a posted entry is reversed, a new entry with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created with its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_balance_entry_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to the original entry's ID."},"children":[]}]}]}]},{"name":"posted_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" posted and finalized on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on or after the given date."},"children":[]}]}]}]},{"name":"posted_at.lte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entries"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" posted and finalized on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on or before the given date."},"children":[]}]}]}]},{"name":"state","in":"query","schemaId":"schema_200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"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":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been successfully posted and affects the account balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is awaiting confirmation and has not yet affected the account balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" failed and did not affect the account balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was returned (e.g., due to an ACH return) and has been reversed."},"children":[]}]}]}]}]},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"type","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":"Filter by the transaction type that caused a change to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1balances~1{balance_id}~1balance_entries/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1balances~1{balance_id}~1balance_entries/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balances/{balance_id}/balance_entries","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"balance_id","in":"path","required":true,"example":"balance_dyz5APsJebDef9oTW9J2Hc","schemaId":"schema_6"}],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"amount","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.gte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lt","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"amount.lte","in":"query","required":false,"example":100,"schemaId":"schema_7"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"entity_id","in":"query","required":false,"example":"TR2vw93rwm6LkH1MES6T9uYe","schemaId":"schema_196"},{"name":"entity_type","in":"query","required":false,"schemaId":"schema_197"},{"name":"id","in":"query","required":false,"example":"balance_entry_7s6EstknMq5KekMooedkES","schemaId":"schema_198"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"parent_balance_entry_id","in":"query","required":false,"example":"balance_entry_xxx","schemaId":"schema_199"},{"name":"posted_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"posted_at.lte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"state","in":"query","required":false,"example":"SUCCEEDED","schemaId":"schema_200"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"type","in":"query","required":false,"schemaId":"schema_201"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/balances/{balance_id}/balance_entries","href":"balances/listbalanceentries","openApiOperationId":"listBalanceEntries","summary":"List Balance Entries"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc/balance_entries\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/200/content/application~1json/examples/List of Balances"]}},"schemaId":"schema_195","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/200/content/application~1json/examples/List of Balances"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1balances~1{balance_id}~1balance_entries/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_195","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/200/content/application~1json/examples/List of Balances"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_195","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/200/content/application~1json/examples/List of Balances"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balances~1{balance_id}~1balance_entries/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/listbalanceentries"}],"panels":[]}]},"httpPath":"/balances/{balance_id}/balance_entries"},{"label":"Fetch a Balance Entry","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balances/getbalanceentry","routeSlug":"/api/balances/getbalanceentry","metadata":{"seo":{"title":"Fetch a Balance Entry","description":"Retrieve the details of a specific Balance Entry."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBalanceEntry","name":"Fetch a Balance Entry","isWebhook":false,"pointer":"/paths/~1balance_entries~1{balance_entry_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a Balance Entry","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":"text","inline":true,"attributes":{"content":"Retrieve the details of a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"balance_entry_id","in":"path","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"balance_entry_2yqLu8vYUroqDByd3bQVvE"}],"pointer":"/paths/~1balance_entries~1{balance_entry_id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1balance_entries~1{balance_entry_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balance_entries/{balance_entry_id}","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[{"name":"balance_entry_id","in":"path","required":true,"example":"balance_entry_2yqLu8vYUroqDByd3bQVvE","schemaId":"schema_6"}],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","404","406"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/balance_entries/{balance_entry_id}","href":"balances/getbalanceentry","openApiOperationId":"getBalanceEntry","summary":"Fetch a Balance Entry"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"A single "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balance_entry","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/200/content/application~1json/examples/Balance Entry"]}},"schemaId":"components/schemas/balance_entry","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/200/content/application~1json/examples/Balance Entry"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"404","description":"Not Found. The requested resource could not be found on the server.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/404/content/application~1json/examples/Not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/404/content/application~1json/examples/Not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}],"pointer":"/paths/~1balance_entries~1{balance_entry_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/balance_entry","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/200/content/application~1json/examples/Balance Entry"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balance_entry","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/200/content/application~1json/examples/Balance Entry"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/404/content/application~1json/examples/Not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/404/content/application~1json/examples/Not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_entries~1{balance_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balances/getbalanceentry"}],"panels":[]}]},"httpPath":"/balance_entries/{balance_entry_id}"}],"content":{"contentType":"group","meta":{"name":"Balances"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balances","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents the current financial state of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It tracks the state of funds processed through the system, including amounts that are:"},"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":"available_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for immediate use or disbursement."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" due to processing times, holds, or other constraints."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"posted_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which reflects the total sum (including both available and pending funds)."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/balances","summary":"List Balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/listbalances","deprecated":false},{"title":"/balances/{balance_id}","summary":"Fetch a Balance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/getbalance","deprecated":false},{"title":"/balances/{balance_id}/balance_entries","summary":"List Balance Entries","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/listbalanceentries","deprecated":false},{"title":"/balance_entries/{balance_entry_id}","summary":"Fetch a Balance Entry","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balances/getbalanceentry","deprecated":false}]}]}]}]}},{"type":"group","label":"Balance Adjustments","link":"/api/balance-adjustments","routeSlug":"/api/balance-adjustments","items":[{"label":"Create a Balance Adjustment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balance-adjustments/createbalanceadjustment","routeSlug":"/api/balance-adjustments/createbalanceadjustment","metadata":{"seo":{"title":"Create a Balance Adjustment","description":"Create a Balance Adjustment to increase (i.e., 'Top-up') or decrease your account balance for Payouts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBalanceAdjustment","name":"Create a Balance Adjustment","isWebhook":false,"pointer":"/paths/~1balance_adjustments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a Balance Adjustment","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":"text","inline":true,"attributes":{"content":"Create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to increase (i.e., 'Top-up') or decrease your account balance for Payouts."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"Content-Type","in":"header","schemaId":"schema_1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data type being sent in the request body must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1balance_adjustments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createBalanceAdjustment","exampleIds":["paths/~1balance_adjustments/post/requestBody/content/application~1json/examples/Balance Adjustment"]}},"schemaId":"components/schemas/createBalanceAdjustment","exampleIds":["paths/~1balance_adjustments/post/requestBody/content/application~1json/examples/Balance Adjustment"],"pointer":"/paths/~1balance_adjustments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/balance_adjustments","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"},{"name":"Content-Type","in":"header","example":"application/json","schemaId":"schema_1"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/createBalanceAdjustment","exampleIds":["paths/~1balance_adjustments/post/requestBody/content/application~1json/examples/Balance Adjustment"]}},"responseCodes":["201","400","401","403","404","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/balance_adjustments","href":"balance-adjustments/createbalanceadjustment","openApiOperationId":"createBalanceAdjustment","summary":"Create a Balance Adjustment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"schemaId":"components/schemas/createBalanceAdjustment","exampleIds":["paths/~1balance_adjustments/post/requestBody/content/application~1json/examples/Balance Adjustment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/createBalanceAdjustment","exampleIds":["paths/~1balance_adjustments/post/requestBody/content/application~1json/examples/Balance Adjustment"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A single Balance Adjustment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balance_adjustment","exampleIds":["paths/~1balance_adjustments/post/responses/201/content/application~1json/examples/Balance Adjustment"]}},"schemaId":"components/schemas/balance_adjustment","exampleIds":["paths/~1balance_adjustments/post/responses/201/content/application~1json/examples/Balance Adjustment"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/400/content/application~1json/examples/Malformed request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/400/content/application~1json/examples/Malformed request"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Owner identity is invalid","paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Forbidden request","paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Could not retrieve owner identity data"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Owner identity is invalid","paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Forbidden request","paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Could not retrieve owner identity data"]},{"code":"404","description":"Not Found - Payment Instrument does not exist.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/404/content/application~1json/examples/Instrument not found"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/404/content/application~1json/examples/Instrument not found"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity - Validation error occurred during balance adjustment creation.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Duplicate idempotency_id","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/idempotency_id too long","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument ID cannot be decoded","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not bank account","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not enabled","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Routing number invalid","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Disbursement not enabled for application","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in platform","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in application","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument identity is not application owner","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Invalid processor","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't find owner identity","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't parse processor type provided","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve facilitating merchant","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve owner identity business data"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Duplicate idempotency_id","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/idempotency_id too long","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument ID cannot be decoded","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not bank account","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not enabled","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Routing number invalid","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Disbursement not enabled for application","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in platform","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in application","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument identity is not application owner","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Invalid processor","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't find owner identity","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't parse processor type provided","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve facilitating merchant","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve owner identity business data"]}],"pointer":"/paths/~1balance_adjustments/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/balance_adjustment","exampleIds":["paths/~1balance_adjustments/post/responses/201/content/application~1json/examples/Balance Adjustment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/balance_adjustment","exampleIds":["paths/~1balance_adjustments/post/responses/201/content/application~1json/examples/Balance Adjustment"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/400/content/application~1json/examples/Malformed request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/400/content/application~1json/examples/Malformed request"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Owner identity is invalid","paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Forbidden request","paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Could not retrieve owner identity data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Owner identity is invalid","paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Forbidden request","paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Could not retrieve owner identity data"]}}},{"code":"404","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/404/content/application~1json/examples/Instrument not found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/404/content/application~1json/examples/Instrument not found"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Duplicate idempotency_id","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/idempotency_id too long","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument ID cannot be decoded","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not bank account","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not enabled","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Routing number invalid","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Disbursement not enabled for application","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in platform","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in application","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument identity is not application owner","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Invalid processor","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't find owner identity","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't parse processor type provided","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve facilitating merchant","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve owner identity business data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Duplicate idempotency_id","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/idempotency_id too long","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument ID cannot be decoded","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not bank account","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not enabled","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Routing number invalid","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Disbursement not enabled for application","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in platform","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in application","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument identity is not application owner","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Invalid processor","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't find owner identity","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't parse processor type provided","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve facilitating merchant","paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve owner identity business data"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance-adjustments/createbalanceadjustment"}],"panels":[]}]},"httpPath":"/balance_adjustments"},{"label":"List Balance Adjustments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/balance-adjustments/listbalanceadjustments","routeSlug":"/api/balance-adjustments/listbalanceadjustments","metadata":{"seo":{"title":"List Balance Adjustments","description":"Retrieve a list of Balance Adjustment resources for an Application."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBalanceAdjustments","name":"List Balance Adjustments","isWebhook":false,"pointer":"/paths/~1balance_adjustments/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Balance Adjustments","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"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":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PLATFORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" credentials can be used to retrieve "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1balance_adjustments/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1balance_adjustments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/balance_adjustments","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/balance_adjustments","href":"balance-adjustments/listbalanceadjustments","openApiOperationId":"listBalanceAdjustments","summary":"List Balance Adjustments"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/balance_adjustments\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_202","exampleIds":["paths/~1balance_adjustments/get/responses/200/content/application~1json/examples/List of Balance Adjustments"]}},"schemaId":"schema_202","exampleIds":["paths/~1balance_adjustments/get/responses/200/content/application~1json/examples/List of Balance Adjustments"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1balance_adjustments/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_202","exampleIds":["paths/~1balance_adjustments/get/responses/200/content/application~1json/examples/List of Balance Adjustments"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_202","exampleIds":["paths/~1balance_adjustments/get/responses/200/content/application~1json/examples/List of Balance Adjustments"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1balance_adjustments/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/balance-adjustments/listbalanceadjustments"}],"panels":[]}]},"httpPath":"/balance_adjustments"}],"content":{"contentType":"group","meta":{"name":"Balance Adjustments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Balance Adjustments","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":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" modifies the account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by adding funds (a 'top-up') or reducing funds for Payouts. Each adjustment is linked to a specific payment rail (e.g., ACH, card, wire)."},"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":"Related Guides:"},"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":"link","inline":true,"attributes":{"href":"/guides/payouts/adding-funds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adding Funds to your Finix Balance"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/balance_adjustments","summary":"Create a Balance Adjustment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/balance-adjustments/createbalanceadjustment","deprecated":false},{"title":"/balance_adjustments","summary":"List Balance Adjustments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/balance-adjustments/listbalanceadjustments","deprecated":false}]}]}]}]}},{"type":"group","label":"Disbursement Rules","link":"/api/disbursement-rules","routeSlug":"/api/disbursement-rules","items":[{"label":"List Disbursement Rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disbursement-rules/listdisbursementrules","routeSlug":"/api/disbursement-rules/listdisbursementrules","metadata":{"seo":{"title":"List Disbursement Rules","description":"Retrieve a list of Disbursement Rule resources linked to an Application / Platform. Currently, there is only one Disbursement Rule object per application / platform."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDisbursementRules","name":"List Disbursement Rules","isWebhook":false,"pointer":"/paths/~1disbursement_rules/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Disbursement Rules","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":"text","inline":true,"attributes":{"content":"Retrieve a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disbursement Rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources linked to an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" / "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Currently, there is only one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disbursement Rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object per application / platform."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For details on how to query endpoints using the available parameters, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/overview/#section/Query-Parameters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query Parameters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"linked_to","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disbursement Rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to."},"children":[]}]}]}],"required":true,"example":"APc9vhYcPsRuTSpKD9KpMtPe"},{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"created_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"created_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"tags.key","in":"query","schemaId":"schema_24","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's key. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags.value","in":"query","schemaId":"schema_25","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by the tag's value. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/tags"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1disbursement_rules/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disbursement_rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disbursement_rules","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"linked_to","in":"query","required":true,"example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_6"},{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"created_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"created_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"tags.key","in":"query","required":false,"example":"card_type","schemaId":"schema_24"},{"name":"tags.value","in":"query","required":false,"example":"business_card","schemaId":"schema_25"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disbursement_rules","href":"disbursement-rules/listdisbursementrules","openApiOperationId":"listDisbursementRules","summary":"List Disbursement Rules"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/disbursement_rules\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disbursement Rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_203","exampleIds":["paths/~1disbursement_rules/get/responses/200/content/application~1json/examples/List of Disbursement Rules"]}},"schemaId":"schema_203","exampleIds":["paths/~1disbursement_rules/get/responses/200/content/application~1json/examples/List of Disbursement Rules"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1disbursement_rules/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_203","exampleIds":["paths/~1disbursement_rules/get/responses/200/content/application~1json/examples/List of Disbursement Rules"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_203","exampleIds":["paths/~1disbursement_rules/get/responses/200/content/application~1json/examples/List of Disbursement Rules"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disbursement-rules/listdisbursementrules"}],"panels":[]}]},"httpPath":"/disbursement_rules"},{"label":"List Current Usages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/disbursement-rules/listcurrentusages","routeSlug":"/api/disbursement-rules/listcurrentusages","metadata":{"seo":{"title":"List Current Usages","description":"Retrieve the current usage for disbursements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCurrentUsages","name":"List Current Usages","isWebhook":false,"pointer":"/paths/~1disbursement_rules~1current_usages/get","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Current Usages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve the current usage for disbursements.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"linked_to","in":"query","schemaId":"schema_6","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disbursement Rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs to."},"children":[]}]}]}],"required":true,"example":"APc9vhYcPsRuTSpKD9KpMtPe"},{"name":"after_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created after the cursor value."},{"name":"before_cursor","in":"query","schemaId":"schema_6","description":"Return every resource created before the cursor value."},{"name":"limit","in":"query","schemaId":"schema_19","description":"The numbers of items to return."},{"name":"updated_at.gte","in":"query","schemaId":"schema_8","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is after the given date."},"children":[]}]}]}]},{"name":"updated_at.lte","in":"query","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"updated_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is before the given date."},"children":[]}]}]}]}],"pointer":"/paths/~1disbursement_rules~1current_usages/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Finix-Version","in":"header","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the API version of your request. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../additional-resources/developers/authentication-and-api-basics/versioning"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Versioning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1disbursement_rules~1current_usages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/disbursement_rules/current_usages","servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"parameters":{"path":[],"query":[{"name":"linked_to","in":"query","required":true,"example":"APc9vhYcPsRuTSpKD9KpMtPe","schemaId":"schema_6"},{"name":"after_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"before_cursor","in":"query","required":false,"schemaId":"schema_6"},{"name":"limit","in":"query","required":false,"example":10,"schemaId":"schema_19"},{"name":"updated_at.gte","in":"query","required":false,"example":"2022-09-27T11:21:23","schemaId":"schema_8"},{"name":"updated_at.lte","in":"query","required":false,"example":"2026-09-27T11:21:23","schemaId":"schema_9"}],"querystring":[],"header":[{"name":"Finix-Version","in":"header","example":"2022-02-01","schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic","x-defaultUsername":"USfdccsr1Z5iVbXDyYt7hjZZ","x-defaultPassword":"313636f3-fac2-45a7-bff7-a334b93e7bda"}],"scopes":[]}],"responseCodes":["200","400","401","403","406","422"],"requestValues":{"security":{"default":{"username":"USfdccsr1Z5iVbXDyYt7hjZZ","password":"313636f3-fac2-45a7-bff7-a334b93e7bda"}}},"pointer":"/disbursement_rules/current_usages","href":"disbursement-rules/listcurrentusages","openApiOperationId":"listCurrentUsages","summary":"List Current Usages"},"definitionSamples":[{"lang":"cURL","label":"curl","source":"curl \"https://finix.sandbox-payments-api.com/disbursement_rules/current_usages?linked_to=APc9vhYcPsRuTSpKD9KpMtPe\" \\\n-H \"Content-Type: application/json\" \\\n-H \"Finix-Version: 2022-02-01\" \\\n-u USfdccsr1Z5iVbXDyYt7hjZZ:313636f3-fac2-45a7-bff7-a334b93e7bda\n"}],"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"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":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disbursement Rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_204","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/200/content/application~1json/examples/List of Disbursement Rules"]}},"schemaId":"schema_204","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/200/content/application~1json/examples/List of Disbursement Rules"],"headers":{"date":{"$ref":"#/components/headers/date"},"finix-apiuser-role":{"$ref":"#/components/headers/finix-apiuser-role"},"x-request-id":{"$ref":"#/components/headers/x-request-id"}},"headerSchemaId":"schema_3"},{"code":"400","description":"Bad Request. The server cannot process the request due to malformed syntax or invalid data.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/400/content/application~1json/examples/Missing query param"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/400/content/application~1json/examples/Missing query param"]},{"code":"401","description":"Unauthorized. Authentication is required and has failed or has not been provided.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/401/content/application~1json/examples/Unauthorized request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/401/content/application~1json/examples/Unauthorized request"]},{"code":"403","description":"Forbidden. The client is authenticated but does not have permission to access the resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/403/content/application~1json/examples/Forbidden request"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/403/content/application~1json/examples/Forbidden request"]},{"code":"406","description":"Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/406/content/application~1json/examples/Not acceptable"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/406/content/application~1json/examples/Not acceptable"]},{"code":"422","description":"Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/422/content/application~1json/examples/Invalid query param value"]}},"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/422/content/application~1json/examples/Invalid query param value"]}],"pointer":"/paths/~1disbursement_rules~1current_usages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_204","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/200/content/application~1json/examples/List of Disbursement Rules"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_204","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/200/content/application~1json/examples/List of Disbursement Rules"]}}},{"code":"400","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/400/content/application~1json/examples/Missing query param"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/400/content/application~1json/examples/Missing query param"]}}},{"code":"401","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/401/content/application~1json/examples/Unauthorized request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/401/content/application~1json/examples/Unauthorized request"]}}},{"code":"403","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/403/content/application~1json/examples/Forbidden request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/403/content/application~1json/examples/Forbidden request"]}}},{"code":"406","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/406/content/application~1json/examples/Not acceptable"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/406/content/application~1json/examples/Not acceptable"]}}},{"code":"422","schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/422/content/application~1json/examples/Invalid query param value"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/genericError","exampleIds":["paths/~1disbursement_rules~1current_usages/get/responses/422/content/application~1json/examples/Invalid query param value"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/disbursement-rules/listcurrentusages"}],"panels":[]}]},"httpPath":"/disbursement_rules/current_usages"}],"content":{"contentType":"group","meta":{"name":"Disbursement Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Disbursement Rules","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":"For the Payouts product, when a payout is executed, such as a Push-To-Card or ACH transaction, Finix checks the transaction against velocity rules and balance rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules establish limits on transactions. For example, there may be a daily transaction limit of 100 transactions ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"count_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or a monthly volume limit of $100,000 ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume_limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). If a transaction exceeds any defined limit, the transaction is rejected."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules are set for entities involved in transactions, including the application, senders, and recipients."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The \"Application\" represents the customer to whom Finix is applying the rules. Application rules are set solely by Finix and are applied to every single transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can establish rules for \"senders\" and \"recipients,\" referring to the parties involved in transactions:"},"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":"In the case of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction, sender rules are applied (either card or ACH rules). The \"target\" of the pull is referred to as the \"sender,\" specifically the customer of Finix's client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Conversely, in the case of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUSH_TO_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUSH_TO_ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction, the recipient rules are applied (either card or ACH rules). The \"target\" of the push is referred to as the \"recipient,\" which is, in turn, the customer of Finix's client."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/disbursement_rules","summary":"List Disbursement Rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disbursement-rules/listdisbursementrules","deprecated":false},{"title":"/disbursement_rules/current_usages","summary":"List Current Usages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/disbursement-rules/listcurrentusages","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/currency":{"id":"components/schemas/currency","kind":"json-schema","title":"currency","data":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]}},"components/schemas/tags":{"id":"components/schemas/tags","kind":"json-schema","title":"tags","data":{"type":"object","title":"tags","additionalProperties":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include up to 50 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key: value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pairs to annotate requests with custom metadata."},"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":"Maximum character length for individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 40."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum character length for individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is 500."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order_number: 25"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"item_type: produce"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"department: sales"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}],"nullable":true}},"components/schemas/create3DSecureSessionUSA":{"id":"components/schemas/create3DSecureSessionUSA","kind":"json-schema","title":"3D Secure Session - Payment Instrument","data":{"title":"3D Secure Session - Payment Instrument","type":"object","properties":{"amount":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount to authenticate, in the smallest unit of the currency (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = $10.00). This amount must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/authorizations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you later create with the session. If the two amounts differ, the liability shift is downgraded."},"children":[]}]}]}],"example":92169},"currency":{"$ref":"#/components/schemas/currency"},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment processes under. Finix validates this ID against the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/authorizations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you create later with the session."},"children":[]}]}]}],"example":"MUmfEGv5bMpSJ9k5TFRUjkmm"},"payment_instrument_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to authenticate. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_instrument_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not both."},"children":[]}]}]}],"example":"PI6iQcTtJNCS8GZAVKYi5Ueb"},"redirect_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"buyer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns to after they finish authentication. The URL must use HTTPS."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix passes this URL to the 3D Secure vendor as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"redirect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_authentication_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When the buyer finishes, the vendor returns them to the URL with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?status={status}&session={session_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" appended. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"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":"Only the redirect flow uses this field. Omit it when you collect the authentication with Finix.js."},"children":[]}]}]}],"example":"https://example.com/3d-secure/return"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant_id","payment_instrument_id"]}},"components/schemas/create3DSecureSessionCAN":{"id":"components/schemas/create3DSecureSessionCAN","kind":"json-schema","title":"3D Secure Session - Payment Instrument - Canada","data":{"title":"3D Secure Session - Payment Instrument - Canada","allOf":[{"$ref":"#/components/schemas/create3DSecureSessionUSA"}]}},"components/schemas/create3DSecureSessionToken":{"id":"components/schemas/create3DSecureSessionToken","kind":"json-schema","title":"3D Secure Session - Token","data":{"title":"3D Secure Session - Token","type":"object","properties":{"amount":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount to authenticate, in the smallest unit of the currency (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = $10.00). This amount must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you later create with the session. If the two amounts differ, the liability shift is downgraded."},"children":[]}]}]}],"example":1000},"currency":{"$ref":"#/components/schemas/currency"},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment processes under. Finix validates this ID against the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you later create with the session."},"children":[]}]}]}],"example":"MUmUNeW5N9Yw8RkLhLcGghy4"},"tags":{"$ref":"#/components/schemas/tags"},"token_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the token to authenticate. Pass either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_instrument_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", not both."},"children":[]}]}]}],"example":"TKiMxe323RE5Dq3wLVtG8kSW"}},"required":["amount","currency","merchant_id","token_id"]}},"components/schemas/created_at":{"id":"components/schemas/created_at","kind":"json-schema","title":"created_at","data":{"type":"string","format":"date-time","description":"Timestamp of when the object was created."}},"components/schemas/updated_at":{"id":"components/schemas/updated_at","kind":"json-schema","title":"updated_at","data":{"type":"string","format":"date-time","description":"Timestamp of when the object was last updated."}},"components/schemas/self":{"id":"components/schemas/self","kind":"json-schema","title":"self","data":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/3d_secure_session":{"id":"components/schemas/3d_secure_session","kind":"json-schema","title":"3D Secure Session","data":{"title":"3D Secure Session","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"3d_secure_session_f3fG3Zj8K958MTP5vpXAXX"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"3d_secure_authentication":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The authentication values the card network returns. Pass this object, or the ID of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", when you create the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/authorizations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"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 field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the authentication process finishes. It stays "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"cardholder_authentication":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provides evidence that the cardholder authentication occurred or that the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attempted authentication. This is unique for each authentication transaction and is sometimes referred to as the cardholder authentication verification value (CAVV)."},"children":[]}]}]}]},"electronic_commerce_indicator":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result of the authentication, and the value that determines who carries chargeback liability for fraud."},"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":"AUTHENTICATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The issuer authenticated the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"buyer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Liability for fraud chargebacks shifts to the issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATTEMPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The issuer could not authenticate the buyer, so the card network authenticated on the issuer's behalf. Liability for fraud chargebacks shifts to the issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NON_AUTHENTICATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The buyer was not authenticated. Liability for fraud chargebacks stays with the seller."},"children":[]}]}]}]}],"enum":["AUTHENTICATED","ATTEMPTED","NON_AUTHENTICATED"]},"transaction_id":{"type":"string","maxLength":36,"description":"The ID the issuer assigns to the 3D Secure transaction."}}},"3d_secure_authentication_session_id":{"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":"The ID of the authentication session with the 3D Secure vendor. This is not the ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"example":"tds_visa_0367b8b7ebd8"},"3d_secure_authentication_url":{"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":"The hosted URL where the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"buyer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" completes authentication. Redirect the buyer to this URL to run the redirect flow. This field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you create the session from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and complete the authentication with Finix.js."},"children":[]}]}]}]},"3d_secure_version":{"type":"string","nullable":true,"description":"The version of the 3D Secure protocol used for the authentication.","example":"2.2.0"},"amount":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount that was authenticated, in the smallest unit of the currency (for example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = $10.00)."},"children":[]}]}]}],"example":1000},"authentication_type":{"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":"How the buyer was authenticated. This field is populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"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":"FRICTIONLESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The issuer authenticated the buyer from the data in the request, without presenting a challenge."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHALLENGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The issuer presented the buyer with a challenge, such as a one-time passcode."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ATTEMPT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card network authenticated on the issuer's behalf."},"children":[]}]}]}]}],"enum":[null,"FRICTIONLESS","CHALLENGE","ATTEMPT"]},"currency":{"$ref":"#/components/schemas/currency"},"failure_code":{"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":"The code for why the authentication process could not finish. This field is populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":[null,"AUTHENTICATION_FAILED","AUTHENTICATION_TIMED_OUT","CARD_NOT_ENROLLED","CHALLENGE_REQUIRED","DIRECTORY_SERVER_UNAVAILABLE","ISSUER_SERVER_UNAVAILABLE","PROTOCOL_ERROR","SUSPECTED_FRAUD","TRANSACTION_CANCELLED_BY_CARDHOLDER","TRANSACTION_NOT_PERMITTED","TRANSIENT_SYSTEM_FAILURE","UNSUPPORTED_3D_SECURE_VERSION"]},"failure_message":{"type":"string","nullable":true,"description":"A human-readable description of why the authentication process could not finish."},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the payment processes under."},"children":[]}]}]}],"example":"MUmUNeW5N9Yw8RkLhLcGghy4"},"payment_instrument_id":{"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":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was authenticated. This field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you create the session from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"PI6iQcTtJNCS8GZAVKYi5Ueb"},"redirect_url":{"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":"The URL the buyer returns to after they finish authentication. This field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you create the session from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"token_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the authentication process. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the process finished. It does not mean the buyer was authenticated: a session where the issuer declined to authenticate the buyer also ends in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_authentication.electronic_commerce_indicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the authentication result."},"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":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The authentication process has not finished."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The authentication process finished and returned a result."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The authentication process could not finish. See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["PENDING","SUCCEEDED","FAILED"]},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"}}}}}},"components/schemas/logref":{"id":"components/schemas/logref","kind":"json-schema","title":"logref","data":{"type":"string","description":"A log reference identifier for the error, useful for debugging and support purposes."}},"components/schemas/genericError":{"id":"components/schemas/genericError","kind":"json-schema","title":"genericError","data":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of errors returned."},"_embedded":{"type":"object","description":"Container for embedded error objects.","properties":{"errors":{"type":"array","description":"List of individual error objects.","items":{"type":"object","description":"Detailed information about an individual error.","properties":{"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The error code. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error code is returned for a 401 Unauthorized or 403 Forbidden request."},"children":[]}]}]}]},"logref":{"$ref":"#/components/schemas/logref"},"message":{"type":"string","description":"A human-friendly error message."},"_links":{"type":"object","description":"Links related to this error.","properties":{"self":{"type":"object","description":"Link to the resource related to the error.","properties":{"href":{"type":"string","description":"URL of the related resource."}}}}}},"additionalProperties":true}}}}},"required":["total","_embedded"]}},"components/schemas/page":{"id":"components/schemas/page","kind":"json-schema","title":"page","data":{"type":"object","description":"Details the page that's returned.","properties":{"limit":{"type":"integer","description":"The number of entries to return."},"next_cursor":{"type":"string","description":"The cursor to use for the next page of results.","nullable":true}}}},"components/schemas/additional_lodging_data":{"id":"components/schemas/additional_lodging_data","kind":"json-schema","title":"additional_lodging_data","data":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains lodging-specific fields for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests. Optional for lodging MCC transactions (MCC 3501–3999, 7011). Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all other transactions."},"children":[]}]}]}],"properties":{"check_in_date":{"type":"object","nullable":true,"description":"The guest's scheduled arrival date.","properties":{"month":{"type":"integer","description":"The month of the check-in date."},"day":{"type":"integer","description":"The day of the check-in date."},"year":{"type":"integer","description":"The year of the check-in date."}}},"check_out_date":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The guest's scheduled departure date. Must represent a date on or after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"check_in_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"month":{"type":"integer","description":"The month of the check-out date."},"day":{"type":"integer","description":"The day of the check-out date."},"year":{"type":"integer","description":"The year of the check-out date."}}},"customer_service_phone":{"type":"string","nullable":true,"description":"The phone number guests can call for support or inquiries related to their stay."},"extra_charge_details":{"type":"object","nullable":true,"description":"Additional charges billed beyond the room rate. Each field represents a specific charge type, in cents.","properties":{"restaurant_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"mini_bar_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"laundry_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"other_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"phone_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"gift_shop_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."}}},"hotel_agreement_number":{"type":"string","nullable":true,"description":"The folio or agreement number associated with the reservation. Max 12 characters; longer values are truncated."},"is_advance_deposit":{"type":"boolean","nullable":true,"default":false,"description":"Indicates whether the lodging charge is an advance deposit."},"is_no_show":{"type":"boolean","nullable":true,"default":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the cardholder is being billed for a reserved room that was not occupied."},"children":[]}]}]}]},"number_of_nights":{"type":"integer","nullable":true,"description":"The total number of nights for the lodging stay."},"property_phone":{"type":"string","nullable":true,"description":"The direct phone number of the lodging property."},"room_rate":{"type":"string","nullable":true,"description":"The nightly room rate, in cents."},"room_tax":{"type":"string","nullable":true,"description":"The tax amount applied to the room rate, in cents."}}}},"components/schemas/country":{"id":"components/schemas/country","kind":"json-schema","title":"country","data":{"type":"string","enum":["ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","XKX","YEM","ZAF","ZMB","ZWE"],"nullable":true}},"components/schemas/address":{"id":"components/schemas/address","kind":"json-schema","title":"address","data":{"type":"object","properties":{"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters).","nullable":true},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"city":{"type":"string","minLength":1,"description":"City (max 20 characters).","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter State code.","nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters).","nullable":true},"country":{"$ref":"#/components/schemas/country"}},"required":["city","country","line1","postal_code","region"]}},"components/schemas/additional_motor_vehicle_rental_data":{"id":"components/schemas/additional_motor_vehicle_rental_data","kind":"json-schema","title":"additional_motor_vehicle_rental_data","data":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Contains motor vehicle rental-specific fields for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" requests. Optional for motor vehicle rental MCC transactions (MCC 3351–3500, 7512). Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all other transactions."},"children":[]}]}]}],"properties":{"motor_vehicle_rental_agreement_number":{"type":"string","nullable":true,"description":"The rental agreement or contract reference number for the rental. Max 9 characters; longer values are truncated."},"customer_service_number":{"type":"string","nullable":true,"description":"The phone number customers can call for support or inquiries related to their rental."},"extra_charge_details":{"type":"object","nullable":true,"description":"Additional charges beyond the base rental rate being billed. Each field represents a specific charge type, in cents.","properties":{"extra_mileage_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"fuel_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"insurance_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"late_return_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"one_way_service_fee_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."},"parking_violation_amount":{"type":"integer","nullable":true,"description":"The amount of the additional charge, in cents."}}},"is_no_show":{"type":"boolean","nullable":true,"default":false,"description":"An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a \"no-show\" charge)."},"number_of_days":{"type":"integer","nullable":true,"description":"The total number of days for the vehicle rental."},"rental_rate":{"type":"string","nullable":true,"description":"The daily rental rate for the vehicle, in cents."},"renter_name":{"type":"string","nullable":true,"description":"The name of the person renting the vehicle."},"pickup_address":{"nullable":true,"description":"The full address of the rental pickup location.","allOf":[{"$ref":"#/components/schemas/address"}]},"pickup_date":{"type":"object","nullable":true,"description":"The scheduled vehicle pickup date.","properties":{"month":{"type":"integer","description":"The month of the pickup date."},"day":{"type":"integer","description":"The day of the pickup date."},"year":{"type":"integer","description":"The year of the pickup date."}}},"return_address":{"nullable":true,"description":"The full address of the vehicle return location.","allOf":[{"$ref":"#/components/schemas/address"}]},"return_date":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The scheduled vehicle return date. Must be on or after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pickup_date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"month":{"type":"integer","description":"The month of the return date."},"day":{"type":"integer","description":"The day of the return date."},"year":{"type":"integer","description":"The year of the return date."}}}}}},"components/schemas/additional_buyer_charges":{"id":"components/schemas/additional_buyer_charges","kind":"json-schema","title":"additional_buyer_charges","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional charges will be incurred by the buyer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following rules apply:"},"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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be enabled to charge these surcharges by setting the appropriate flags for each applicable surcharge to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using the PUT "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the following charges can be applied during creation."},"children":[]}]}]}]}],"nullable":true,"properties":{"convenience_amount":{"type":"integer","description":"A convenience fee to charge the buyer for the transaction. This object property is mutually exclusive.","nullable":true},"rent_surcharge_amount":{"type":"integer","description":"A rent surcharge to charge the buyer for the transaction. This object property is mutually exclusive.","nullable":true},"surcharge_amount":{"type":"integer","description":"A surcharge amount to charge the buyer for the transaction. This object property is mutually exclusive.","nullable":true}}}},"components/schemas/additional_healthcare_data":{"id":"components/schemas/additional_healthcare_data","kind":"json-schema","title":"additional_healthcare_data","data":{"type":"object","nullable":true,"properties":{"clinic_amount":{"type":"integer","description":"A clinic or other qualified medical amount for the transaction.","nullable":true},"dental_amount":{"type":"integer","description":"The dental amount for the transaction.","nullable":true},"prescription_amount":{"type":"integer","description":"The prescription/RX amount for the transaction.","nullable":true},"vision_amount":{"type":"integer","description":"The vision/optical amount for the transaction.","nullable":true}}}},"components/schemas/customer_reference_number":{"id":"components/schemas/customer_reference_number","kind":"json-schema","title":"customer_reference_number","data":{"type":"string","description":"A unique reference ID for the order such as a purchase order (PO) number or invoice number. A purchase order number (PO number) is a unique code assigned to a specific order of goods or services. The buyer creates this number when they make a purchase order. It helps both the buyer and the seller track the order, match invoices, and keep accurate financial records.","maxLength":17}},"components/schemas/additional_purchase_data":{"id":"components/schemas/additional_purchase_data","kind":"json-schema","title":"additional_purchase_data","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the purchase used for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/level-2-level-3-processing"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Level 2 and Level 3 Processing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Please note that Visa is ending its Level 2 offering in April 2026."},"children":[]}]}]}],"nullable":true,"properties":{"customer_reference_number":{"$ref":"#/components/schemas/customer_reference_number"},"customs_duty_amount":{"type":"integer","nullable":true,"description":"The duty in cents on the total purchase amount for the order."},"destination_country_code":{"type":"string","nullable":true,"description":"The ISO country code of the order destination."},"destination_postal_code":{"type":"string","nullable":true,"description":"The postal code of the order destination (10 characters).","maxLength":10},"discount_amount":{"type":"integer","nullable":true,"description":"The amount in cents of the discount for the order. You must include this field to qualify for Level 3 interchange benefits. Even if the value is (0), you should pass the field to qualify for Level 3."},"invoice_reference_number":{"type":"string","nullable":true,"description":"The order's invoice number (max 15 characters).","maxLength":15},"order_date":{"type":"object","nullable":true,"properties":{"day":{"type":"integer","description":"Day of purchase (between 1 and 31)."},"month":{"type":"integer","description":"Month of purchase (between 1 and 12)."},"year":{"type":"integer","description":"Year of purchase (4-digit).","minimum":1990}}},"sales_tax":{"type":"integer","nullable":true,"description":[{"$$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":"Total aggregate tax amount in cents for the entire purchase. Field is automatically calculated if you pass in the itemized tax amounts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For non-taxable transactions either set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to 0 or omit from payload and also set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_exempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True"},"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":"Request must align so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_excluding_sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_including_sales_tax"},"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 Visa, this field no longer qualifies for lower interchange after April 17, 2026. Include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"item_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Level 3 processing."},"children":[]}]}]}]}]},"sales_tax_finix_generated":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sales tax amount in cents Finix calculated from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"item_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" line items."},"children":[]}]}]}],"nullable":true},"ship_from_postal_code":{"type":"string","nullable":true,"description":"The postal code from where order is shipped (10 characters).","maxLength":10},"shipping_amount":{"type":"integer","nullable":true,"description":"The shipping cost in cents for the order.\n"},"tax_exempt":{"type":"boolean","description":[{"$$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":"For tax exempt purchases set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True"},"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":"If set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", request can't include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"item_data":{"type":"array","description":"Additional information about the transaction. Used for Level 2 and Level 3 Processing.","items":{"type":"object","properties":{"amount_excluding_sales_tax":{"type":"integer","description":[{"$$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":"Total cost of the line item in cents, excluding tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must align with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_excluding_sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_including_sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"amount_including_sales_tax":{"type":"integer","description":[{"$$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":"Total cost of the line item in cents, including tax."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must align with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_excluding_sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_including_sales_tax"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"commodity_code":{"description":"A commodity code is a numeric code representing a particular product or service as defined by the National Institute of Governmental Purchasing. The code can be 3, 5, 7, or 11 digits in length. The longer the code the more granular the description of the product/service. (max 12 characters).","type":"string","maxLength":12},"cost_per_unit":{"type":"integer","description":"The price in cents, excluding tax, of one unit of the item purchased."},"item_description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"item_data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supplied (max 25 characters)."},"children":[]}]}]}],"maxLength":25},"item_discount_amount":{"type":"integer","description":"The item discount amount in cents. You must include this field to qualify for Level 3 interchange benefits. Even if the value is (0), you should pass the field to qualify for Level 3."},"merchant_product_code":{"type":"string","description":"Merchant defined product code (max 12 characters).","maxLength":12},"quantity":{"type":"number","description":"The number of items purchased. Must be greater than 0.","minimum":1,"maximum":99},"unit_of_measure":{"type":"string","description":"The unit of measure of the purchased item (max 3 characters).","maxLength":3},"sales_tax_amount":{"type":"integer","description":"The sales tax amount in cents for the line item."},"sales_tax_rate":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sales tax rate for the line item as a decimal (e.g., 0.25 equals 25%)."},"children":[]}]}]}],"example":0.25}}}}}}},"components/schemas/amount":{"id":"components/schemas/amount","kind":"json-schema","title":"amount","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount that will be debited in cents (e.g. 100 cents to debit $1.00)."},"children":[]}]}]}],"example":5000,"format":"int64"}},"components/schemas/card_present_details":{"id":"components/schemas/card_present_details","kind":"json-schema","title":"card_present_details","data":{"type":"object","description":"Details needed to process card present transactions.","nullable":true,"properties":{"approval_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID used to identify the approval of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"brand":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The brand of the card saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"digital_signature_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a signature was collected this will contain the the id of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource which stored the signature."},"children":[]}]}]}],"nullable":true},"emv_data":{"type":"object","description":"Encrypted card data used to process the transaction.","nullable":true,"properties":{"application_identifier":{"type":"string","description":"ID of the application used in the transaction. Tag 9F06 from the EMVCo standard."},"application_label":{"type":"string","description":"EMV application label. Tag 50 from the EMVCo standard."},"application_preferred_name":{"type":"string","description":"EMV application label with formatting (if provided). Tag 9F12 from the EMVCo standard.","nullable":true},"application_transaction_counter":{"type":"string","description":"Transaction number for the EMV application. Tag 9F36 from the EMVCo standard."},"cryptogram":{"type":"string","description":"Cryptogram returned by the card. Tag 9F26 of the EMVCo standard."},"issuer_code_table_index":{"type":"string","description":"The alphabet code table (according to ISO 8859) used by the EMV application (if provided). Tag 9F11.","nullable":true},"pin_verified":{"type":"boolean","description":"Whether the cardholder's PIN number was verified."},"tags":{"$ref":"#/components/schemas/tags"}}},"entry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the card payment method used to process the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible enums are:"},"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":"UNKNOWN - The method by which the payment card was used is unknown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SWIPED - The card was swiped through a POS terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONTACTLESS - The payment was made by tapping a card on a POS terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHIP_ENTRY - The payment card was inserted into a card reader."},"children":[]}]}]}]}],"enum":["UNKNOWN","SWIPED","CONTACTLESS","CHIP_ENTRY"],"nullable":true},"masked_account_number":{"type":"string","description":"Last four digits of the bank account number.","nullable":true},"name":{"type":"string","description":"The name of the card owner.","nullable":true},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used in the transaction (or the original payment)."},"children":[]}]}]}]}}}},"components/schemas/created_via_transfers_authorizations":{"id":"components/schemas/created_via_transfers_authorizations","kind":"json-schema","title":"created_via_transfers_authorizations","data":{"type":"string","description":"Gives more information about the product flow that was used to create the resource. Finix retains the right to add additional enums for this field without it being a breaking change.","default":"UNKNOWN","enum":["CARD_PRESENT_ANDROID_APP","CARD_PRESENT_ANDROID_APP_MANUAL_ENTRY","CARD_PRESENT_ANDROID_D135_SDK","CARD_PRESENT_DEVICE_READER_SDK","CARD_PRESENT_IOS_APP","CARD_PRESENT_IOS_APP_MANUAL_ENTRY","CARD_PRESENT_IOS_D135_SDK","CARD_PRESENT_IOS_TAP_TO_PAY","CARD_PRESENT_IOS_TAP_TO_PAY_SDK","CARD_PRESENT_SEMI_INTEGRATED_API","CARD_PRESENT_STANDALONE","CARD_PRESENT_STANDALONE_MANUAL_ENTRY","CHECKOUT_FORM","CYBERSOURCE","DEVICE_ORDER","PAYMENT_LINK","PAYOUT_LINK","PLUGIN_ADMOJI","PLUGIN_CHECKOUT_CHAMP","PLUGIN_FYNTEK","PLUGIN_GAMBLE_ID","PLUGIN_GAMMA_SWEEP","PLUGIN_GR4VY","PLUGIN_HYPERSWITCH","PLUGIN_LACORE","PLUGIN_PAYSIGHT","PLUGIN_PRYZR","PLUGIN_SERVMAN","PLUGIN_SOAP_PAY","PLUGIN_STICKYIO","PLUGIN_TAGADA","PLUGIN_WOO_COMMERCE","PLUGIN_VRIO","SUBSCRIPTION","UNKNOWN","VIRTUAL_TERMINAL"]}},"components/schemas/failure_code":{"id":"components/schemas/failure_code","kind":"json-schema","title":"failure_code","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/implementation-and-testing/failure-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/failure_message":{"id":"components/schemas/failure_message","kind":"json-schema","title":"failure_message","data":{"type":"string","description":"A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment.","nullable":true}},"components/schemas/idempotency_id":{"id":"components/schemas/idempotency_id","kind":"json-schema","title":"idempotency_id","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass any randomly generated or internal ID to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/idempotent-requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"idempotently"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or refund requests."},"children":[]}]}]}],"nullable":true}},"components/schemas/ip_address_v4":{"id":"components/schemas/ip_address_v4","kind":"json-schema","title":"ip_address_v4","data":{"type":"string","description":"The card brands require the customer's IP address for online gaming clients. Only supports Internet Protocol version 4 (IPv4).","example":"192.168.1.1","nullable":true}},"components/schemas/ip_address_details":{"id":"components/schemas/ip_address_details","kind":"json-schema","title":"ip_address_details","data":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all users except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PLATFORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" users."},"children":[]}]}]}],"properties":{"ipv4":{"type":"object","properties":{"estimated_location":{"$ref":"#/components/schemas/address"},"ip":{"$ref":"#/components/schemas/ip_address_v4"},"latitude":{"type":"number","description":"Geo-location based on the IP address."},"longitude":{"type":"number","description":"Geo-location based on the IP address."}}}}}},"components/schemas/raw":{"id":"components/schemas/raw","kind":"json-schema","title":"Raw","data":{"title":"Raw","description":"Raw response from the processor.","anyOf":[{"type":"object","nullable":true},{"type":"string","nullable":true}]}},"components/schemas/source":{"id":"components/schemas/source","kind":"json-schema","title":"source","data":{"type":"string","example":"PIxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where funds get debited."},"children":[]}]}]}]}},"components/schemas/application_link":{"id":"components/schemas/application_link","kind":"json-schema","title":"application_link","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/merchant_identity":{"id":"components/schemas/merchant_identity","kind":"json-schema","title":"merchant_identity","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was submitted with."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}},"components/schemas/transfers":{"id":"components/schemas/transfers","kind":"json-schema","title":"transfers","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/authorization":{"id":"components/schemas/authorization","kind":"json-schema","title":"Authorization","data":{"type":"object","title":"Authorization","description":"A charge authorization","properties":{"id":{"type":"string","example":"AUxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"3d_secure_session":{"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":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that authenticated the buyer. This field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the payment was not authenticated with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"3d_secure_session_f3fG3Zj8K958MTP5vpXAXX"},"3ds_redirect_url":{"type":"string","description":"The redirect URL used for 3DS transactions (if supported by the processor).","nullable":true},"additional_lodging_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object detailing any additional lodging amounts included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_lodging_data"}]},"additional_motor_vehicle_rental_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object detailing any additional motor vehicle rental amounts included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_motor_vehicle_rental_data"}]},"additional_buyer_charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The buyer charges are mutually exclusive."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"additional_healthcare_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object detailing any additional healthcare amounts included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_healthcare_data"}]},"additional_purchase_data":{"$ref":"#/components/schemas/additional_purchase_data"},"address_verification":{"type":"string","description":"Details the results of the Address Verification checks.","nullable":true},"amount":{"$ref":"#/components/schemas/amount"},"amount_requested":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default_partial_authorization_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount_requested"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the amount the cardholder attempted to authorize."},"children":[]}]}]}]},"application":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"card_present_details":{"$ref":"#/components/schemas/card_present_details"},"credential_on_file":{"description":"An object that contains information about the credential on file authorization.\n","type":"object","nullable":true,"properties":{"initial_transfer_id":{"type":"string","description":"The ID of the initial transfer in the series."},"type":{"type":"string","enum":["RECURRING","UNSCHEDULED"],"description":"The type of credential on file authorization."}}},"currency":{"$ref":"#/components/schemas/currency"},"created_via":{"$ref":"#/components/schemas/created_via_transfers_authorizations"},"device":{"type":"string","example":"DVxxxxxxxxxxxxxxxxxx","description":"The ID of the activated device.","nullable":true},"expires_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expiration time."},"children":[]}]}]}],"format":"date-time"},"failure_code":{"$ref":"#/components/schemas/failure_code"},"failure_message":{"$ref":"#/components/schemas/failure_message"},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the buyer 'Identity' to run the card present authorization. Finix tokenizes the card associated with the provided 'Identity' and processes the authorization, removing the need to create a blank buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":null},"idempotency_id":{"$ref":"#/components/schemas/idempotency_id"},"ip_address_details":{"$ref":"#/components/schemas/ip_address_details"},"is_void":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been voided."},"children":[]}]}]}]},"merchant":{"type":"string","example":"MUxxxxxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"merchant_identity":{"type":"string","example":"IDxxxxxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource used by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was processed under."},"children":[]}]}]}]},"messages":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Message field that provides additional details. This field is typically "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"items":{"type":"string"}},"network_details":{"type":"object","description":"Contains network-specific fields used by issuers to identify transactions.","nullable":true,"properties":{"brand":{"type":"string","description":"Card brand associated with the saved payment instrument.","example":"VISA"},"authorization_code":{"type":"string","description":"Code returned by the issuing bank when a transaction is authorized.","example":82533}}},"raw":{"$ref":"#/components/schemas/raw"},"receipt_last_printed_at":{"type":"string","format":"date-time","description":"Timestamp when the receipt was last printed.","nullable":true},"security_code_verification":{"type":"string","description":"Details the results of the Security Code Verification che","nullable":true},"source":{"$ref":"#/components/schemas/source"},"state":{"type":"string","enum":["CANCELED","PENDING","FAILED","SUCCEEDED","UNKNOWN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"supplemental_fee":{"type":"integer","format":"int64","description":"Amount in cents for which an additional fee will be created in addition to any fees created from the assigned fee profile.","nullable":true},"tags":{"$ref":"#/components/schemas/tags"},"trace_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trace ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The processor sends back the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trace_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so you can track the authorization end-to-end."},"children":[]}]}]}]},"transfer":{"type":"string","example":"TRxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that gets created when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" moves to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"void_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the void attempt for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["UNATTEMPTED","PENDING","SUCCEEDED"]},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"application":{"$ref":"#/components/schemas/application_link"},"device":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"merchant_identity":{"$ref":"#/components/schemas/merchant_identity"},"transfer":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" moves to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"transfers":{"$ref":"#/components/schemas/transfers"}}}}}},"components/schemas/next":{"id":"components/schemas/next","kind":"json-schema","title":"next","data":{"type":"object","description":"Link to the next page of entries.","properties":{"href":{"type":"string"}}}},"components/schemas/createAuthorizationMinimalFields":{"id":"components/schemas/createAuthorizationMinimalFields","kind":"json-schema","title":"Authorization - Minimal Fields","data":{"title":"Authorization - Minimal Fields","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/3d_secure_authentication":{"id":"components/schemas/3d_secure_authentication","kind":"json-schema","title":"3d_secure_authentication","data":{"type":"object","nullable":true,"properties":{"cardholder_authentication":{"type":"string","description":"Provides evidence that the cardholder authentication occurred or that the merchant attempted authentication. This is unique for each authentication transaction and is sometimes referred to as the cardholder authentication verification value (CAVV)."},"electronic_commerce_indicator":{"type":"string","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"AUTHENTICATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Approved by 3D Secure Vendor."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"ATTEMPTED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Issuer or cardholder does not support 3D Secure."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"NON_AUTHENTICATED"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Did not pass in 3D Secure Data or passed in incorrect data when attempting 3D Secure."},"children":[]}]}]}]}]},"transaction_id":{"type":"string","maxLength":36,"description":"Unique identifier for the 3D Secure transaction."}},"required":["cardholder_authentication","electronic_commerce_indicator","transaction_id"]}},"components/schemas/amount_breakdown":{"id":"components/schemas/amount_breakdown","kind":"json-schema","title":"amount_breakdown","data":{"type":"object","description":"The individual charges/fees that add up to the total amount.","properties":{"subtotal_amount":{"type":"integer","description":"The subtotal amount before any taxes, shipping, or additional charges are applied."},"shipping_amount":{"type":"integer","description":"The amount charged for shipping the items in the order."},"estimated_tax_amount":{"type":"integer","description":"The estimated amount of tax applied to the order."},"additional_buyer_charges":{"$ref":"#/components/schemas/additional_buyer_charges"},"discount_amount":{"type":"integer","description":"A reduction applied to the total amount."},"tip_amount":{"type":"integer","description":"The tip amount included in the order total."}}}},"components/schemas/items":{"id":"components/schemas/items","kind":"json-schema","title":"items","data":{"type":"array","default":[],"description":"An itemized list of products/services.","items":{"type":"object","properties":{"description":{"type":"string","description":"A item description."},"image_details":{"type":"object","nullable":true,"description":"Product/service image locations.","properties":{"primary_image_url":{"type":"string","description":"The location of a item image."},"alternative_image_urls":{"type":"array","description":"The locations of backup images if there is an issue with the primary image.","items":{"type":"string"}}}},"item_details":{"type":"object","nullable":true,"description":"Additional details about the item.","properties":{"commodity_code":{"type":"string","nullable":true,"description":"Commodity code for the item.","example":"175-62-20"},"cost_per_unit":{"type":"integer","nullable":true,"description":"Cost per unit in cents.","example":500},"merchant_product_code":{"type":"string","nullable":true,"description":"Merchant's product code for the item.","example":"1149611"},"unit_of_measure":{"type":"string","nullable":true,"description":"Unit of measure for the item.","example":"BX"}}},"name":{"type":"string","description":"The item name."},"price_details":{"type":"object","description":"Additional details about the price.","properties":{"sale_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The on-sale price of the item if it is different from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"regular_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currency":{"$ref":"#/components/schemas/currency"},"price_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the price is on-sale ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PROMOTIONAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the normal price ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REGULAR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["PROMOTIONAL","REGULAR"]},"regular_amount":{"type":"integer","description":"The standard price of the item without any adjustments applied (e.g. discounts, taxes, sales)."},"amount_excluding_sales_tax":{"type":"integer","description":"The amount excluding sales tax."},"item_discount_amount":{"type":"integer","description":"The item discount."}}},"quantity":{"type":"integer","description":"The item quantity."}}}}},"components/schemas/requested_delivery_methods":{"id":"components/schemas/requested_delivery_methods","kind":"json-schema","title":"requested_delivery_methods","data":{"type":"array","description":"An array of delivery methods used to send the receipt.","items":{"type":"object","description":"An individual delivery method.","required":["type","destinations"],"properties":{"type":{"type":"string","description":"The type of delivery method used to send the receipt.","enum":["EMAIL","SMS","PRINT"]},"destinations":{"type":"array","description":"A list of destinations to send the receipt.","items":{"type":"string","description":"A destination to send the receipt."}}}}}},"components/schemas/createAuthorization":{"id":"components/schemas/createAuthorization","kind":"json-schema","title":"Authorization - All Fields","data":{"title":"Authorization - All Fields","type":"object","properties":{"3d_secure_authentication":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3D secure information required to create a 3D secure "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/3d_secure_authentication"}]},"additional_buyer_charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The buyer charges are mutually exclusive."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"additional_healthcare_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object detailing any additional healthcare amounts included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only available for USA merchants. Only non-healthcare merchant category codes (MCCs) are required to pass in additional healthcare data and have the necessary SIGIS certification."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_healthcare_data"}]},"additional_purchase_data":{"$ref":"#/components/schemas/additional_purchase_data"},"amount":{"$ref":"#/components/schemas/amount"},"credential_on_file":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that contains information about the credential on file transfer."},"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":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The type of credential on file transfer. Must be one of the following values:"},"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":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A transfer that is part of a series of transfers scheduled at regular intervals. Interchange benefits for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions are available only to approved bill payment merchants in the telecommunications and cable industries (MCC 4814 and 4899)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNSCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A merchant-initiated, one-time transaction using stored credentials, triggered when specific conditions in a cardholder agreement are met—not on a fixed schedule."},"children":[]}]}]}]}]}]}],"type":"object","properties":{"type":{"type":"string","enum":["RECURRING","UNSCHEDULED"]}},"required":["type"]},"currency":{"$ref":"#/components/schemas/currency"},"device":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"idempotency_id":{"$ref":"#/components/schemas/idempotency_id"},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to run the card present authorization. Finix tokenizes the card associated with the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and processes the authorization, removing the need to create a blank buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ip_address_v4":{"$ref":"#/components/schemas/ip_address_v4"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"operation_key":{"type":"string","description":"Details the operation that's performed in the authorization.","enum":["AUTHORIZATION","CARD_PRESENT_AUTHORIZATION"]},"partial_authorization":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial authorizations let you collect part of the amount if the cardholder lacks funds for the full amount. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable partial authorizations for a transaction. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partial_authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default_partial_authorization_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ignored."},"children":[]}]}]}]},"receipt_options":{"type":"object","description":"If provided the information will be used to generate a receipt if transaction is successful.","nullable":true,"properties":{"additional_details":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of key-value pairs for including metadata or custom information related to the receipt. Each entry must contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These fields are currently supported for device-generated receipts only."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The label or title for the additional detail. This should be a short, human-readable identifier such as \"Invoice Number\", \"VIN\", \"Service Date\", or \"Technician\".","maxLength":25,"example":"Invoice Number"},"value":{"type":"string","description":"The corresponding value for the detail. This can be any string that provides relevant context or information, such as an invoice number, vehicle identification number, or date.","maxLength":25,"example":"4FEBVZP0-0002"}},"required":["name","value"]}},"amount_breakdown":{"$ref":"#/components/schemas/amount_breakdown"},"items":{"$ref":"#/components/schemas/items"},"requested_delivery_methods":{"$ref":"#/components/schemas/requested_delivery_methods"}}},"security_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/fraud-and-risk/risk-rules-card-checks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Verification Checks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"},"statement_descriptor":{"type":"string","maxLength":20,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that appears on the card statement."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createAuthorizationCanada":{"id":"components/schemas/createAuthorizationCanada","kind":"json-schema","title":"Authorization - Canada","data":{"title":"Authorization - Canada","allOf":[{"$ref":"#/components/schemas/createAuthorizationMinimalFields"}]}},"components/schemas/createAuthorization3DSecure":{"id":"components/schemas/createAuthorization3DSecure","kind":"json-schema","title":"Authorization - 3D Secure","data":{"title":"Authorization - 3D Secure","type":"object","properties":{"3d_secure_authentication":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3D secure information required to create a 3D secure "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/3d_secure_authentication"}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createAuthorization3DSecureSession":{"id":"components/schemas/createAuthorization3DSecureSession","kind":"json-schema","title":"Authorization - 3D Secure Session","data":{"title":"Authorization - 3D Secure Session","type":"object","properties":{"3d_secure_session":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used for the buyer's authentication flow. It must correspond to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must not already have been used by another transaction. For the redirect flow, wait for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; with Finix.js, submit after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" callback even if the resource still reads "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"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 field is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when Finix runs the authentication, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you authenticate the buyer with your own 3D Secure vendor."},"children":[]}]}]}],"example":"3d_secure_session_c5dR7Wk1H392XJq6tzNCUb"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/authorizations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under. This must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["3d_secure_session","amount","currency","merchant","source"]}},"components/schemas/statement_descriptor":{"id":"components/schemas/statement_descriptor","kind":"json-schema","title":"statement_descriptor","data":{"type":"string","maxLength":20,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that appears on the buyer's bank or card statement."},"children":[]}]}]}]}},"components/schemas/createAuthorizationBuyerCharges":{"id":"components/schemas/createAuthorizationBuyerCharges","kind":"json-schema","title":"Authorization - Buyer Charges","data":{"title":"Authorization - Buyer Charges","type":"object","properties":{"additional_buyer_charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The buyer charges are mutually exclusive."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"},"statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createAuthorizationCardPresent":{"id":"components/schemas/createAuthorizationCardPresent","kind":"json-schema","title":"Authorization - Card Present","data":{"title":"Authorization - Card Present","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"device":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to run the card present authorization. Finix tokenizes the card associated with the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and processes the authorization, removing the need to create a blank buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"operation_key":{"type":"string","description":"Details the operation that's performed in the authorization.","enum":["CARD_PRESENT_AUTHORIZATION"]},"receipt_options":{"type":"object","description":"If provided the information will be used to generate a receipt if transaction is successful.","nullable":true,"properties":{"additional_details":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of key-value pairs for including metadata or custom information related to the receipt. Each entry must contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These fields are currently supported for device-generated receipts only."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The label or title for the additional detail. This should be a short, human-readable identifier such as \"Invoice Number\", \"VIN\", \"Service Date\", or \"Technician\".","maxLength":25,"example":"Invoice Number"},"value":{"type":"string","description":"The corresponding value for the detail. This can be any string that provides relevant context or information, such as an invoice number, vehicle identification number, or date.","maxLength":25,"example":"4FEBVZP0-0002"}},"required":["name","value"]}},"amount_breakdown":{"$ref":"#/components/schemas/amount_breakdown"},"items":{"$ref":"#/components/schemas/items"},"requested_delivery_methods":{"$ref":"#/components/schemas/requested_delivery_methods"}}},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","device","operation_key"]}},"components/schemas/createAuthorizationCVV":{"id":"components/schemas/createAuthorizationCVV","kind":"json-schema","title":"Authorization - Authorization with CVV","data":{"title":"Authorization - Authorization with CVV","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"security_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3-4 digit security code for the card (i.e. CVV code). Include the CVV code of the card to include "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/fraud-and-risk/risk-rules-card-checks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Verification Checks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createAuthorizationVerifyCVVAndAVS":{"id":"components/schemas/createAuthorizationVerifyCVVAndAVS","kind":"json-schema","title":"Authorization - Verify CVV and AVS","data":{"title":"Authorization - Verify CVV and AVS","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"$0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify a card's CVV and AVS without debiting the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/createAuthorizationMinimalFields"}]}},"components/schemas/createAuthorizationAutoRental":{"id":"components/schemas/createAuthorizationAutoRental","kind":"json-schema","title":"Authorization - Motor Vehicle Rental","data":{"title":"Authorization - Motor Vehicle Rental","allOf":[{"type":"object","properties":{"additional_motor_vehicle_rental_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing motor vehicle rental-specific fields for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional for motor vehicle rental MCC transactions (MCC 3351–3500, 7512)."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_motor_vehicle_rental_data"}]}}},{"$ref":"#/components/schemas/createAuthorization"}]}},"components/schemas/createAuthorizationGaming":{"id":"components/schemas/createAuthorizationGaming","kind":"json-schema","title":"Authorization - Gaming","data":{"title":"Authorization - Gaming","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"ip_address_v4":{"$ref":"#/components/schemas/ip_address_v4"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createAuthorizationLodging":{"id":"components/schemas/createAuthorizationLodging","kind":"json-schema","title":"Authorization - Lodging","data":{"title":"Authorization - Lodging","allOf":[{"type":"object","properties":{"additional_lodging_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing lodging-specific fields for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional for lodging MCC transactions (MCC 3501–3999, 7011)."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_lodging_data"}]}}},{"$ref":"#/components/schemas/createAuthorization"}]}},"components/schemas/createAuthorizationLevel2Processing":{"id":"components/schemas/createAuthorizationLevel2Processing","kind":"json-schema","title":"Authorization - Level 2 Processing","data":{"title":"Authorization - Level 2 Processing","type":"object","properties":{"additional_purchase_data":{"$ref":"#/components/schemas/additional_purchase_data"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createAuthorizationLevel3Processing":{"id":"components/schemas/createAuthorizationLevel3Processing","kind":"json-schema","title":"Authorization - Level 3 Processing","data":{"title":"Authorization - Level 3 Processing","type":"object","properties":{"additional_purchase_data":{"$ref":"#/components/schemas/additional_purchase_data"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createAuthorizationRecurringUnscheduled":{"id":"components/schemas/createAuthorizationRecurringUnscheduled","kind":"json-schema","title":"Authorization - Recurring or Unscheduled","data":{"title":"Authorization - Recurring or Unscheduled","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"credential_on_file":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that contains information about the credential on file transfer."},"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":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The type of credential on file transfer. Must be one of the following values:"},"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":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A transfer that is part of a series of transfers scheduled at regular intervals. Interchange benefits for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions are available only to approved bill payment merchants in the telecommunications and cable industries (MCC 4814 and 4899)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNSCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A merchant-initiated, one-time transaction using stored credentials, triggered when specific conditions in a cardholder agreement are met—not on a fixed schedule."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"initial_transfer_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The ID of the initial transfer in the recurring series. This field is required for both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNSCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types."},"children":[]}]}]}]}],"type":"object","properties":{"initial_transfer_id":{"type":"string","description":"The ID of the initial transfer in the series."},"type":{"type":"string","enum":["RECURRING","UNSCHEDULED"]}},"required":["type"]},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/capture_amount":{"id":"components/schemas/capture_amount","kind":"json-schema","title":"capture_amount","data":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the  "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  you would like to capture in cents. Must be less than or equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/split_transfers":{"id":"components/schemas/split_transfers","kind":"json-schema","title":"split_transfers","data":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array used to detail how funds from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will split and the amount "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receive."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rules:"},"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 combined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submitted in the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchants can be based in the United States or Canada."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount type must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIXED"},"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":"For more information, see:"},"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":"link","inline":true,"attributes":{"href":"../../../../guides/online-payments/payment-features/split-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"items":{"type":"object","nullable":true,"properties":{"merchant":{"type":"string","description":[{"$$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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will receive the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Split Transactions, the merchants specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object are the ancillary merchants."},"children":[]}]}]}]}],"nullable":false},"amount":{"type":"integer","format":"int64","description":[{"$$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 amount of funds that get split and paid out to the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"Must be less than or equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer."},"children":[]}]}]}]}],"nullable":false},"fee":{"type":"integer","description":[{"$$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 processing fee is deducted when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receives their payout, specified in cents."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be less than or equal to the total amount being split for the designated "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"By default, this fee is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"nullable":true},"tags":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/tags"}]}}}}},"components/schemas/captureAuthorization":{"id":"components/schemas/captureAuthorization","kind":"json-schema","title":"Capture Authorization","data":{"title":"Capture Authorization","type":"object","properties":{"capture_amount":{"$ref":"#/components/schemas/capture_amount"},"fee":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum amount of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"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":"text","inline":true,"attributes":{"content":"If the fees applied by the 'Fee Profile' are "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"higher"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than the value passed in 'fee', 'fee' will not be applied and have no effect."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the fees applied by the 'Fee Profile' are "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lower"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"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 additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"split_transfers":{"description":[{"$$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 array used to detail how funds for the created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will split and the amount "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be equal to or less than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submitted in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"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 more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../guides/online-payments/payment-features/split-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/split_transfers"}]}},"required":["capture_amount"]}},"components/schemas/captureAuthorizationCardPresent":{"id":"components/schemas/captureAuthorizationCardPresent","kind":"json-schema","title":"Capture Card Present Authorization","data":{"title":"Capture Card Present Authorization","type":"object","properties":{"capture_amount":{"$ref":"#/components/schemas/capture_amount"}},"required":["capture_amount"]}},"components/schemas/captureAuthorizationSplitTransfers":{"id":"components/schemas/captureAuthorizationSplitTransfers","kind":"json-schema","title":"Capture Authorization with Split Transfers","data":{"title":"Capture Authorization with Split Transfers","type":"object","properties":{"capture_amount":{"$ref":"#/components/schemas/capture_amount"},"split_transfers":{"description":[{"$$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 array used to detail how funds for the created "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will split and the amount "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be equal to or less than the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submitted in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"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 more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../guides/online-payments/payment-features/split-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/split_transfers"}]}},"required":["capture_amount"]}},"components/schemas/voidAuthorization":{"id":"components/schemas/voidAuthorization","kind":"json-schema","title":"Void an Authorization","data":{"title":"Void an Authorization","type":"object","properties":{"void_me":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to void the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/id":{"id":"components/schemas/id","kind":"json-schema","title":"id","data":{"type":"string","minLength":1,"description":"The ID of the resource."}},"components/schemas/balance":{"id":"components/schemas/balance","kind":"json-schema","title":"balance","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents funds in different stages of finality."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" separates settled funds, usable funds, and in-flight"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactions to ensure safe payouts and accurate accounting."},"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":"posted_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reflects only finalized transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates what can be safely used or withdrawn"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"at the current moment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shows the projected balance after all pending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"transactions complete."},"children":[]}]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"available_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of funds that are currently safe to use or withdraw."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This balance reflects settled funds minus any initiated outflows"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(such as payouts) that reduce availability immediately, even if"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"they have not yet fully posted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Funds from incoming transactions (such as top-ups) are not included"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"until they are finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the posted balance is $1,000, a $500 payout is initiated, and a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$600 top-up is pending, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"available_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is $500."},"children":[]}]}]}]}]},"currency":{"$ref":"#/components/schemas/currency"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the resource (e.g., an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Application"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked to."},"children":[]}]}]}]},"linked_type":{"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 type of resource identified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["APPLICATION"]},"pending_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The projected balance after all in-flight transactions are finalized."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount includes the posted balance adjusted by pending incoming"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and outgoing transactions, regardless of whether those funds are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currently available for use."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the posted balance is $1,000, a $500 payout is pending, and a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"$600 top-up is pending, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is $1,100."},"children":[]}]}]}]}]},"posted_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total balance derived only from finalized, settled transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This amount represents the authoritative ledger balance and does not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"include any pending incoming or outgoing transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If $1,000 has fully settled and no transactions have posted since,"},"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":"posted_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is $1,000, even if payouts or top-ups are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"currently in progress."},"children":[]}]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of transactions stored/ledgered on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["DISBURSEMENT"]},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]}}}}}}}},"components/schemas/balance_entry":{"id":"components/schemas/balance_entry","kind":"json-schema","title":"balance_entry","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"created_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the application user that created this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currency":{"$ref":"#/components/schemas/currency"},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"entity_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the resource that caused the change to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., \"top-up\") or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"entity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource type that caused the change to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["BALANCE_ADJUSTMENT","TRANSFER"]},"estimated_posted_date":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp estimating when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be posted (i.e., the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the resource (e.g., an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Application"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked to."},"children":[]}]}]}]},"linked_type":{"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 type of resource identified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["APPLICATION"]},"parent_balance_entry_id":{"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_balance_entry_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" refers to the ID of the original "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is only applicable for transactions that have been reversed after being posted (i.e., the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). For instance, if a transaction with the ID "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance_entry_xyz"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is reversed, the newly created reversal entry will have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_balance_entry_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that matches the ID of the original transaction, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"balance_entry_xyz"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"posted_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was posted and finalized on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., state changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). This field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the entry has not been posted."},"children":[]}]}]}],"nullable":true},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"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":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The balance entry has been successfully posted and affects the account balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The balance entry is awaiting confirmation and has not yet affected the account balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The balance entry failed and did not affect the account balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The balance entry was returned (e.g., due to an ACH return) and has been reversed."},"children":[]}]}]}]}],"type":"string","enum":["SUCCEEDED","PENDING","FAILED","RETURNED"]},"tags":{"$ref":"#/components/schemas/tags"},"transaction_date":{"type":"string","format":"date-time","description":"The date of the transaction.","nullable":true},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The transaction type that caused a change to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["BALANCE_TOP_UP_ACH","BALANCE_WITHDRAWAL_ACH","MANUAL_BALANCE_ADJUSTMENT_DECREASE","MANUAL_BALANCE_ADJUSTMENT_INCREASE","PULL_FROM_ACH","PULL_FROM_CARD","PUSH_TO_ACH","PUSH_TO_CARD","PULL_FROM_SAME_DAY_ACH","PUSH_TO_SAME_DAY_ACH"]},"wire_details":{"type":"object","description":"Wire transfer details, if applicable.","properties":{"external_reference_number":{"type":"string","description":"External reference number for the wire transfer.","nullable":true}}},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]}}}}}}}},"components/schemas/application_id":{"id":"components/schemas/application_id","kind":"json-schema","title":"application_id","data":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the resource was created under."},"children":[]}]}]}]}},"components/schemas/balance_adjustment":{"id":"components/schemas/balance_adjustment","kind":"json-schema","title":"balance_adjustment","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"application_id":{"$ref":"#/components/schemas/application_id"},"balance_entry_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A ledger record that tracks individual financial movements within a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currency":{"type":"string","description":"ISO 4217 3 letter currency code.","enum":["USD"]},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"failure_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/handling-payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"failure_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/handling-payout-failures"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failure Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"idempotency_id":{"$ref":"#/components/schemas/idempotency_id"},"instrument_id":{"type":"string","description":"The account, card, or bank account that is credited or debited as part of the adjustment."},"processor":{"type":"string","description":"The payment processing entity responsible for handling transactions, fund movements, etc., between different financial accounts.","enum":["DUMMY_V1","FINIX_V1"]},"rail":{"type":"string","enum":["ACH"],"description":"The method of adjustment."},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", indicating whether the adjustment was successful or failed."},"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":"SUBMITTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The balance adjustment has been initiated but is not yet confirmed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The adjustment was successful, and the funds are available. This typically occurs 1-3 business days after "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUBMITTED"},"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":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Finix was unable to process the adjustment, and the balance was not updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The adjustment was initially successful, but a subsequent return resulted in a reversal of the balance increase."},"children":[]}]}]}]}],"enum":["FAILED","RETURNED","SUBMITTED","SUCCEEDED"]},"top_up_config_id":{"type":"string","nullable":true,"description":"The ID of the top-up configuration that created the adjustment."},"trace_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier for tracking the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" across its lifecycle."},"children":[]}]}]}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" increases or decreases the account balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable values:"},"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":"TOP_UP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Adds funds to the balance (e.g., a deposit or manual funding)."},"children":[]}]}]}]}],"enum":["TOP_UP"]},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"application":{"$ref":"#/components/schemas/application_link"},"self":{"type":"object","properties":{"href":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]}}}}}}}},"components/schemas/createBalanceAdjustment":{"id":"components/schemas/createBalanceAdjustment","kind":"json-schema","title":"createBalanceAdjustment","data":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"type":"string","description":"ISO 4217 3 letter currency code.","enum":["USD"]},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"idempotency_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass any randomly generated or internal ID to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/section/idempotent-requests"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"idempotently"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" identify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be unique per application and no more than 255 characters. If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already exists with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"idempotency_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the request is rejected with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"422"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":255,"nullable":true},"instrument_id":{"type":"string","description":"The account, card, or bank account that is credited or debited as part of the adjustment."},"processor":{"type":"string","description":"The payment processing entity responsible for handling transactions, fund movements, etc., between different financial accounts.","enum":["DUMMY_V1"]},"rail":{"type":"string","enum":["ACH"],"description":"The method of adjustment."},"tags":{"$ref":"#/components/schemas/tags"},"top_up_config_id":{"type":"string","description":"The ID of the top-up configuration that created the adjustment.","nullable":true},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Balance Adjustment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" increases or decreases the account balance."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable values:"},"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":"TOP_UP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Adds funds to the balance (e.g., a deposit or manual funding)."},"children":[]}]}]}]}],"enum":["TOP_UP"]}},"required":["amount","currency","description","instrument_id","processor","rail"]}},"components/schemas/device_configuration":{"id":"components/schemas/device_configuration","kind":"json-schema","title":"device_configuration","data":{"type":"object","properties":{"automatic_receipt_delivery_methods":{"type":"array","description":"Receipt delivery methods that are automatically triggered after a transaction.","nullable":true,"items":{"type":"string"}},"available_receipt_methods":{"type":"array","description":"Receipt delivery methods available for the buyer to select on the device.","nullable":true,"items":{"type":"string"}},"allow_debit":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable processing of transactions through Debit rails. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Debit card transactions will instead be processed through Credit rails. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATACAP_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"default":true},"allow_standalone_authorizations":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether the device allows initialization authorizations on its interface."},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"default":false},"allow_standalone_refunds":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether the device allows initialization refunds on its interface. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"default":false},"allow_standalone_sales":{"type":"boolean","description":"Sets whether the device allows initialization sales on its interface.","default":false},"bypass_device_on_capture":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether or not the device will be used to capture transactions. This field should be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless there are special circumstances."},"children":[]}]}]}],"nullable":true,"default":false},"check_for_duplicate_transactions":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets if the device will check for duplicate transactions. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATACAP_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}]},"display_tip_on_receipt":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether the device will display the blank tip amount on the receipt for authorizations to be later captured. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"default":false},"idle_image_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the file to be displayed on the device when it is idle. Passing a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resets the device's idle image to the default."},"children":[]}]}]}],"nullable":true},"idle_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the idle message text on the terminal. This is what will be presented on the welcome screen. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"nullable":true},"prompt_amount_confirmation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets if the cardholder needs to confirm the amount they'll pay. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATACAP_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"default":true},"prompt_for_signature":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines when the terminal prompts for an e-signature."},"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":"ALWAYS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The terminal will always request an e-signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The terminal will never request an e-signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ON_NETWORK_RECOMMENDATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The terminal follows card network recommendations on whether to prompt for a signature."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ON_THRESHOLD_AMOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The terminal requests an e-signature only when the transaction amount is greater than or equal to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signature_threshold_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["ALWAYS","NEVER","ON_NETWORK_RECOMMENDATION","ON_THRESHOLD_AMOUNT"]},"prompt_manual_entry":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets if the device allows for manual entry as a card input method. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATACAP_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only. On "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATACAP_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if this is set to true manual entry will be the default entry option."},"children":[]}]}]}],"default":false},"prompt_receipt_confirmation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether or not the device presents a screen prompting the buyer to print receipt at the end of the transaction flow. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"default":true},"prompt_tip_on_receipt":{"type":"boolean","description":"Sets whether the device prints a tip line on the receipt for the buyer to fill in manually.","default":false},"prompt_tip_on_screen":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets whether the device will display the suggested tipping screen. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"default":false},"signature_threshold_amount":{"description":"The transaction amount at which the terminal prompts for an e-signature."},"surcharge_basis_points":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the transaction amount that a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" charges the buyer when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value cannot exceed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"300"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., 3%). For devices on Standalone Mode, the Finix Payment Application on the terminal will calculate and send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the surcharge added. Customers integrated directly into Finix API must contact Support to incorporate surcharging appropriately into their integration."},"children":[]}]}]}],"nullable":true,"default":0,"maximum":300},"tipping_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that sets the configurations for the tipping page if it appears. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"properties":{"allow_custom_tip":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the buyer to set a custom tip. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"default":true},"fixed_options":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the fixed amount that will be displayed on the terminal. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[100, 150, 200]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be three integer values that represent cent values. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}]},"percent_options":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the percentages that will be displayed on the terminal. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[18, 20, 22]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be three integer values that represent percentages. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}]},"percent_tipping_threshold":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inclusive value at which the terminal will present a percent based prompt instead of a fixed value prompt. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}]}}}}}},"components/schemas/device":{"id":"components/schemas/device","kind":"json-schema","title":"Device","data":{"title":"Device","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"android_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Android version installed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"connection":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The connection status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"configuration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Information used to configure how the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" handles transaction flows."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/device_configuration"}]},"configuration_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Response-only field. Information used to configure how the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" handles transaction flows."},"children":[]}]}]}],"nullable":true,"allOf":[{"$ref":"#/components/schemas/device_configuration"}]},"description":{"type":"string","description":"Additional information about device (e.g. self serving terminal).","nullable":true},"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates disabled."},"children":[]}]}]}]},"firmware_version":{"type":"string","description":"The current version of the device's firmware."},"idle_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets the idle message text on the terminal. This is what will be presented on the welcome screen. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only."},"children":[]}]}]}],"nullable":true},"idle_image_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the file to be displayed on the device when it is idle. Passing a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resets the device's idle image to the default."},"children":[]}]}]}],"nullable":true},"integration_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the operating mode of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_APP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" devices operate within the standard Finix ecosystem. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SDK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" devices are for customers who are building their own PAX app."},"children":[]}]}]}],"enum":["PAYMENT_APP","SDK"],"default":"PAYMENT_APP"},"merchant":{"type":"string","example":"MUxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"model":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The model type of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["IOS_TAP_TO_PAY","PAX_A35","PAX_A800","PAX_A3700","PAX_A920PRO","PAX_D135","PAX_IM30"]},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used for filtering purposes."},"children":[]}]}]}]},"payment_app_version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The device’s current app version."},"children":[]}]}]}]},"prompt_signature":{"type":"string","description":"When to prompt for a signature.","enum":["ALWAYS"]},"serial_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The serial_number is a unique identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", located on the back and typically composed of ~16 digits. Ensure the serial number is set before activating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", though it can also be added later using a PUT request."},"children":[]}]}]}],"nullable":true},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"authorizations":{"type":"object","properties":{"href":{"type":"string"}}},"merchant":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merhcant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that was used in the request."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}},"transfers":{"type":"object","properties":{"href":{"type":"string"}}}}}}}},"components/schemas/updateDeviceActivate":{"id":"components/schemas/updateDeviceActivate","kind":"json-schema","title":"Device - Activate","data":{"title":"Device - Activate","type":"object","properties":{"action":{"type":"string","enum":["ACTIVATE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action you want to perform on the device. Use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACTIVATE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to activate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}},"required":["action"]}},"components/schemas/updateDeviceCancel":{"id":"components/schemas/updateDeviceCancel","kind":"json-schema","title":"Device - Cancel","data":{"title":"Device - Cancel","type":"object","properties":{"action":{"type":"string","enum":["CANCEL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action you want to perform on the device. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCEL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to cancel any active transaction and return to the idle screen."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}},"required":["action"]}},"components/schemas/updateDeviceDeactivate":{"id":"components/schemas/updateDeviceDeactivate","kind":"json-schema","title":"Device - Deactivate","data":{"title":"Device - Deactivate","type":"object","properties":{"action":{"type":"string","enum":["DEACTIVATE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action you want to perform on the device. Use "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DEACTIVATE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to deactivate the device."},"children":[]}]}]}]}},"required":["action"]}},"components/schemas/updateDeviceIdleFileImageMessage":{"id":"components/schemas/updateDeviceIdleFileImageMessage","kind":"json-schema","title":"Device - Update Idle File Image and Message","data":{"title":"Device - Update Idle File Image and Message","type":"object","properties":{"configuration":{"type":"object","description":"Device configuration settings.","properties":{"idle_image_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the file to be displayed on the device when it is idle. Passing a value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resets the device's idle image to the default."},"children":[]}]}]}],"nullable":true},"idle_message":{"type":"string","description":"A message to display when the terminal is idle.","nullable":true}}}}}},"components/schemas/updateDeviceSurcharges":{"id":"components/schemas/updateDeviceSurcharges","kind":"json-schema","title":"Device - Update Surcharges","data":{"title":"Device - Update Surcharges","type":"object","properties":{"configuration":{"type":"object","description":"Device configuration settings.","properties":{"surcharge_basis_points":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Represents the transaction amount that a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" charges the buyer when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The value cannot exceed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"300"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., 3%). For devices on Standalone Mode, the Finix Payment Application on the terminal will calculate and send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request with the surcharge added. Customers integrated directly into Finix API must contact Support to incorporate surcharging appropriately into their integration."},"children":[]}]}]}],"default":0,"maximum":300}}}}}},"components/schemas/rule":{"id":"components/schemas/rule","kind":"json-schema","title":"rule","data":{"type":"object","description":"A rule that sets limits on transactions.\n","properties":{"count_limit":{"type":"integer","description":"A limit on the number of transactions."},"volume_limit":{"type":"integer","description":"A limit on the volume of transactions."},"enabled":{"type":"boolean","description":"Whether the rule is enabled."},"day":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of the week the rule applies to. For DAILY rules, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported (i.e., the rule applies to all days)."},"children":[]}]}]}],"enum":["ALL"]}},"required":["count_limit","enabled","volume_limit"]}},"components/schemas/daily_rule":{"id":"components/schemas/daily_rule","kind":"json-schema","title":"daily_rule","data":{"allOf":[{"$ref":"#/components/schemas/rule"},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For DAILY rules, only a single rule is allowed, and it must apply to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" days."},"children":[]}]}]}],"properties":{"day":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of the week the rule resets. At present, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported (i.e., for a given rule, you must set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"enum":["ALL"]}}}]}},"components/schemas/daily_rule_configuration":{"id":"components/schemas/daily_rule_configuration","kind":"json-schema","title":"Daily Rule Configuration","data":{"title":"Daily Rule Configuration","description":"Configuration settings for a DAILY rule.","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of rule configuration. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TIME_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rules reset based on a time frame."},"children":[]}]}]}],"enum":["TIME_RANGE"],"example":"TIME_RANGE"},"currency":{"$ref":"#/components/schemas/currency"},"time_frame":{"type":"string","enum":["DAILY"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How often the rule resets. For this schema, always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAILY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"DAILY"},"start_time":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time at which the rule resets. Accepts a value between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":11},"time_zone":{"type":"string","description":"The time zone used to determine when the rule resets."},"rules":{"type":"array","description":"A list of rules for DAILY time frame.","items":{"$ref":"#/components/schemas/daily_rule"}}},"required":["type","currency","time_frame","start_time","time_zone","rules"]}},"components/schemas/monthly_rule_configuration":{"id":"components/schemas/monthly_rule_configuration","kind":"json-schema","title":"Monthly Rule Configuration","data":{"title":"Monthly Rule Configuration","description":"Configuration settings for a MONTHLY rule.","type":"object","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of rule configuration. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TIME_RANGE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rules reset based on a time frame."},"children":[]}]}]}],"enum":["TIME_RANGE"],"example":"TIME_RANGE"},"currency":{"$ref":"#/components/schemas/currency"},"time_frame":{"type":"string","enum":["MONTHLY"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How often the rule resets. For this schema, always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MONTHLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MONTHLY"},"start_time":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time at which the rule resets. Accepts a value between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"24"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":11},"time_zone":{"type":"string","description":"The time zone used to determine when the rule resets."},"start_date":{"type":"integer","description":"The day of the month that the rule resets.","example":15},"rules":{"type":"array","description":"A list of rules for MONTHLY time frame.","items":{"$ref":"#/components/schemas/rule"}}},"required":["type","currency","time_frame","start_time","time_zone","start_date","rules"]}},"components/schemas/maximum_transaction_amount":{"id":"components/schemas/maximum_transaction_amount","kind":"json-schema","title":"Maximum Transaction Amount","data":{"title":"Maximum Transaction Amount","type":"object","description":"An object that contains settings for volume limits on individual transactions. This is a GLOBAL rule type that applies universally without time-based resets.\n","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of rule configuration. For this schema, always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GLOBAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["GLOBAL"],"example":"GLOBAL"},"currency":{"$ref":"#/components/schemas/currency"},"max_transaction_amount":{"type":"integer","description":"A volume limit for every transaction.","example":5000001}},"required":["type","currency","max_transaction_amount"]}},"components/schemas/recipient_sender_rule_details":{"id":"components/schemas/recipient_sender_rule_details","kind":"json-schema","title":"recipient_sender_rule_details","data":{"type":"object","description":"A container for rule configurations.","properties":{"ach_rules":{"type":"array","title":"ACH Rule Configurations","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of configurations for ACH rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule."},"children":[]}]}]}],"items":{"oneOf":[{"$ref":"#/components/schemas/daily_rule_configuration"},{"$ref":"#/components/schemas/monthly_rule_configuration"},{"$ref":"#/components/schemas/maximum_transaction_amount"}]}},"card_rules":{"type":"array","title":"Card Rule Configurations","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of configurations for card rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule."},"children":[]}]}]}],"items":{"oneOf":[{"$ref":"#/components/schemas/daily_rule_configuration"},{"$ref":"#/components/schemas/monthly_rule_configuration"},{"$ref":"#/components/schemas/maximum_transaction_amount"}]}},"balance_adjustment_rules":{"type":"array","title":"Balance Adjustment Rule Configurations","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of configurations for balance adjustment rules. Each rule can be a DAILY TIME_RANGE rule, MONTHLY TIME_RANGE rule, or GLOBAL rule."},"children":[]}]}]}],"items":{"oneOf":[{"$ref":"#/components/schemas/daily_rule_configuration"},{"$ref":"#/components/schemas/monthly_rule_configuration"},{"$ref":"#/components/schemas/maximum_transaction_amount"}]}}}}},"components/schemas/disbursement_rule":{"id":"components/schemas/disbursement_rule","kind":"json-schema","title":"disbursement_rule","data":{"type":"object","description":"A high-level object containing one or more rules and their configurations.","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application_details":{"$ref":"#/components/schemas/recipient_sender_rule_details"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disbursement Rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["APPLICATION","PLATFORM"]},"recipient_details":{"$ref":"#/components/schemas/recipient_sender_rule_details"},"sender_details":{"$ref":"#/components/schemas/recipient_sender_rule_details"},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"}}}}}},"components/schemas/velocity":{"id":"components/schemas/velocity","kind":"json-schema","title":"velocity","data":{"type":"object","description":"An object that contains the current usage and limits for disbursements.\n","properties":{"current_volume":{"type":"integer","description":"The current volume of disbursements."},"current_count":{"type":"integer","description":"The current count of disbursements."},"volume_limit":{"type":"integer","description":"The volume limit for disbursements."},"count_limit":{"type":"integer","description":"The count limit for disbursements."},"window_reset":{"type":"string","format":"date-time","description":"The date and time when the usage window resets."}}}},"components/schemas/current_usage":{"id":"components/schemas/current_usage","kind":"json-schema","title":"current_usage","data":{"type":"object","properties":{"ach_velocity":{"type":"object","description":"An object that contains the current usage and limits for ACH disbursements.\n","properties":{"daily_velocity":{"$ref":"#/components/schemas/velocity"},"monthly_velocity":{"$ref":"#/components/schemas/velocity"}}},"card_velocity":{"type":"object","description":"An object that contains the current usage and limits for Card disbursements.\n","properties":{"daily_velocity":{"$ref":"#/components/schemas/velocity"},"monthly_velocity":{"$ref":"#/components/schemas/velocity"}}},"balance_adjustment_velocity":{"type":"object","description":"An object that contains the current usage and limits for balance adjustments.\n","properties":{"daily_velocity":{"$ref":"#/components/schemas/velocity"},"monthly_velocity":{"$ref":"#/components/schemas/velocity"}}},"currency":{"$ref":"#/components/schemas/currency"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The identifier for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disbursement Rule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["APPLICATION","PLATFORM"]},"type":{"type":"string","description":[{"$$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":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOTAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TOTAL"]},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"}}}}}},"components/schemas/dispute":{"id":"components/schemas/dispute","kind":"json-schema","title":"Dispute","data":{"type":"object","title":"Dispute","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objected created for a chargeback or customer disputes."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The next "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" required to move forward with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (in cents)."},"children":[]}]}]}],"nullable":true},"application":{"$ref":"#/components/schemas/application_id"},"dispute_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" received by the processor. Any data from the processor can get included."},"children":[]}]}]}],"type":"object","properties":{"arn":{"type":"string","description":"The Acquirer Reference Number (ARN) is a unique identifier assigned to a card transaction."},"case_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The case number the processor has given the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in their internal database."},"children":[]}]}]}],"nullable":true},"pin_debit_adjustment_number":{"type":"string","description":"A number used by the processor to identify the funds that are getting disputed.","nullable":true},"reason_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code used by the processor and card networks to identify why the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" got filed."},"children":[]}]}]}],"nullable":true}}},"evidence_submitted":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the uploaded evidence after it has been submitted to the issuing bank. This field reflects how the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is moving forward following the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/disputes/submitdisputeevidence"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"submission of dispute evidence"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information on challenging a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/disputes/responding-to-disputes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responding to Disputes"},"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":"Possible values are:"},"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":"INQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Updated to this value if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute#state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the time of submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHARGEBACK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Updated to this value if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute#state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the time of submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No evidence has been uploaded or submitted yet."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_SUPPORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The processor or dispute type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute#reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") does not support evidence submission."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Occurs if evidence details couldn't be successfully processed or retrieved."},"children":[]}]}]}]}],"enum":["INQUIRY","CHARGEBACK","NONE","NOT_SUPPORTED","UNKNOWN"]},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the seller's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. This is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that was used to create the seller's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the seller's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. This is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" account the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was filed against."},"children":[]}]}]}]},"message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional dispute details. This field is typically "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"occurred_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A timestamp of when the disputed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created."},"children":[]}]}]}],"format":"date-time","nullable":true},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The system-defined reason for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Available values 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":"code","inline":true,"attributes":{"content":"CLERICAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An error occurred while processing the sale, or the cardholder has an issue with the transaction and refuses the goods."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FRAUD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The cardholder claims they didn't approve or authorize the transaction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FRAUD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the primary reason disputes get created."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The issuing bank requests more information to determine if a transaction was legitimate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUALITY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The cardholder has issues with the quality of the goods or services received. Reasons can include receiving damaged goods or a service that doesn't match what's promised."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TECHNICAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A technical issued caused the transaction to process funds incorrectly."},"children":[]}]}]}]}],"enum":["CLERICAL","FRAUD","INQUIRY","QUALITY","TECHNICAL"]},"respond_by":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A timestamp of when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must respond to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"response_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details the state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and what action the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs to take. Possible values are:"},"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":"NEEDS_RESPONSE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" needs to respond to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute#respond_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp. For details on how to respond to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/disputes/responding-to-disputes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responding to Disputes"},"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":"code","inline":true,"attributes":{"content":"RESPONDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The issuing bank has received the evidence and actively reviewing it. No action needed from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"code","inline":true,"attributes":{"content":"ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has accepted the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is accepted, you concede that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not worth challenging or representing. For details on how to accept a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/disputes/accepting-disputes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepting a Dispute"},"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":"code","inline":true,"attributes":{"content":"NO_RESPONSE_ALLOWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The final "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute#response_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOST"},"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":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Occurs when testing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Disputes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the sandbox on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" processor or in production on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VANTIV_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" processor."},"children":[]}]}]}]}],"enum":["NEEDS_RESPONSE","RESPONDED","ACCEPTED","NO_RESPONSE_ALLOWED","UNKNOWN"]},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current overall state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Disputes are initially created with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. The decision of the issuing bank is final for all parties. Possible values 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":"code","inline":true,"attributes":{"content":"INQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is being reviewed by the buyer's issuing bank. No changes can be made while in this state. If a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" reaches this state, the bank is requesting additional information from the seller to prove the transaction was legitimate."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The default initial state of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It also acts as a transitional state after an accept request is submitted. The state will eventually change based on the transaction 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":"text","inline":true,"attributes":{"content":"For a dispute on a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sale"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a dispute on a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Changes to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when accepted."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is lost, and the cardholder keeps the credit. No further changes can be made."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WON"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is won, the credit is reversed, and funds are returned to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". No further changes can be made."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/disputes/dispute-states"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute States"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["INQUIRY","PENDING","LOST","WON"]},"transfer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"example":"TRxxxxxxxxxxxxxxxxxx"},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"adjustment_transfers":{"type":"object","properties":{"href":{"type":"string"}}},"application":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the resource was created under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"evidence":{"type":"object","properties":{"href":{"type":"string"}}},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}},"transfer":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" realted to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}}}}}},"components/schemas/updateDispute":{"id":"components/schemas/updateDispute","kind":"json-schema","title":"updateDispute","data":{"type":"object","properties":{"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/dispute_evidence":{"id":"components/schemas/dispute_evidence","kind":"json-schema","title":"dispute_evidence","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"$ref":"#/components/schemas/application_id"},"dispute":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the evidence."},"children":[]}]}]}]},"state":{"type":"string","enum":["PENDING","SUCCEEDED","CANCELED","FAILED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The result after uploading evidence."},"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":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The evidence file has not yet been validated. No user action is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The evidence file has passed validation and can be submitted to the card networks."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The evidence file upload was not completed due to user action."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The evidence file could not be processed. Check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the specific reason and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a user-safe description of the issue."},"children":[]}]}]}]}]},"failure_code":{"type":"string","nullable":true,"enum":["MALWARE_DETECTED","GENERIC_FAILURE","FILE_SIZE_LIMIT_EXCEEDED","TOTAL_COMBINED_FILE_SIZE_LIMIT_EXCEEDED","TOTAL_PAGE_COUNT_LIMIT_EXCEEDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason the evidence file failed processing. Populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise."},"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":"MALWARE_DETECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The file was flagged for suspicious content and cannot be accepted."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERIC_FAILURE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An unexpected error occurred. Contact support for details."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILE_SIZE_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The file exceeds the maximum allowed file size."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOTAL_COMBINED_FILE_SIZE_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The total size of all uploaded evidence exceeds the maximum combined file size limit."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOTAL_PAGE_COUNT_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The total number of pages across all uploaded evidence exceeds the maximum allowed page count."},"children":[]}]}]}]}]},"failure_message":{"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":"A human-readable message explaining why the evidence file failed processing. Populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" otherwise. Safe to surface directly in a UI."},"children":[]}]}]}]},"identity":{"type":"string","example":"IDpYDM7J9n57q849o9E9yNrG","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the seller's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. This is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that was used to create the seller's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchant":{"type":"string","example":"MUucec6fHeaWo3VHYoSkUySM","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the seller's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. This is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" account the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was filed against."},"children":[]}]}]}]},"content_type":{"type":"string","example":"application/pdf","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The MIME type of the uploaded evidence file (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"image/jpeg"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"extension":{"type":"string","example":"pdf","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The file extension, a suffix at the end of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"file_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (letters following last period)."},"children":[]}]}]}]},"file_name":{"type":"string","example":"evidence.pdf","description":"The name of the uploaded evidence file."},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}}}}}}},"components/schemas/uploadDisputeEvidence":{"id":"components/schemas/uploadDisputeEvidence","kind":"json-schema","title":"uploadDisputeEvidence","data":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The binary contents of the file.","example":"@evidence.jpeg"}}}},"components/schemas/updateDisputeEvidence":{"id":"components/schemas/updateDisputeEvidence","kind":"json-schema","title":"updateDisputeEvidence","data":{"type":"object","properties":{"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/ach_basis_points_fee_limit":{"id":"components/schemas/ach_basis_points_fee_limit","kind":"json-schema","title":"ach_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum ACH basis points fee (in cents) incurred for each individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/ach_basis_points":{"id":"components/schemas/ach_basis_points","kind":"json-schema","title":"ach_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of an eCheck (also called ACH payments). Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}]}},"components/schemas/ach_credit_return_fixed_fee":{"id":"components/schemas/ach_credit_return_fixed_fee","kind":"json-schema","title":"ach_credit_return_fixed_fee","data":{"type":"integer","description":"A fixed amount (in cents) that will be charged to the seller for receiving an ACH Credit Return.","nullable":true}},"components/schemas/ach_debit_return_fixed_fee":{"id":"components/schemas/ach_debit_return_fixed_fee","kind":"json-schema","title":"ach_debit_return_fixed_fee","data":{"type":"integer","description":"A fixed amount (in cents) that will be charged to the seller for receiving an ACH Debit Return.","nullable":true}},"components/schemas/ach_fixed_fee":{"id":"components/schemas/ach_fixed_fee","kind":"json-schema","title":"ach_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/ach_notice_of_change_credit_fixed_fee":{"id":"components/schemas/ach_notice_of_change_credit_fixed_fee","kind":"json-schema","title":"ach_notice_of_change_credit_fixed_fee","data":{"type":"integer","description":"The amount in cents charged as a fixed fee for processing ACH credit transactions that result in a Notice of Change (NOC).","nullable":true}},"components/schemas/ach_notice_of_change_debit_fixed_fee":{"id":"components/schemas/ach_notice_of_change_debit_fixed_fee","kind":"json-schema","title":"ach_notice_of_change_debit_fixed_fee","data":{"type":"integer","description":"Represents the fixed fee in cents for processing ACH debit transactions that generate a Notice of Change (NOC).","nullable":true}},"components/schemas/ach_validation_plaid_fixed_fee":{"id":"components/schemas/ach_validation_plaid_fixed_fee","kind":"json-schema","title":"ach_validation_plaid_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents charged when a USD bank account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created using Plaid."},"children":[]}]}]}],"nullable":true}},"components/schemas/afterpay_basis_points":{"id":"components/schemas/afterpay_basis_points","kind":"json-schema","title":"afterpay_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each Afterpay Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/afterpay_fixed_fee":{"id":"components/schemas/afterpay_fixed_fee","kind":"json-schema","title":"afterpay_fixed_fee","data":{"type":"integer","description":"Fee in cents incurred for each individual Afterpay Transfer.","nullable":true}},"components/schemas/american_express_assessment_basis_points":{"id":"components/schemas/american_express_assessment_basis_points","kind":"json-schema","title":"american_express_assessment_basis_points","data":{"type":"integer","description":"Applies to gross American Express card volume.","nullable":true}},"components/schemas/american_express_basis_points":{"id":"components/schemas/american_express_basis_points","kind":"json-schema","title":"american_express_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each American Express Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/american_express_charge_dues_assessments":{"id":"components/schemas/american_express_charge_dues_assessments","kind":"json-schema","title":"american_express_charge_dues_assessments","data":{"type":"integer","description":"A fee associated with American Express's assessment of dues or ongoing charges for services provided through the American Express payment network.","nullable":true}},"components/schemas/american_express_charge_interchange":{"id":"components/schemas/american_express_charge_interchange","kind":"json-schema","title":"american_express_charge_interchange","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to incur interchange fees for American Express "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/american_express_externally_funded_basis_points":{"id":"components/schemas/american_express_externally_funded_basis_points","kind":"json-schema","title":"american_express_externally_funded_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each American Express externally funded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/american_express_externally_funded_fixed_fee":{"id":"components/schemas/american_express_externally_funded_fixed_fee","kind":"json-schema","title":"american_express_externally_funded_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual American Express externally funded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/american_express_fixed_fee":{"id":"components/schemas/american_express_fixed_fee","kind":"json-schema","title":"american_express_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual American Express "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/ancillary_fixed_fee_primary":{"id":"components/schemas/ancillary_fixed_fee_primary","kind":"json-schema","title":"ancillary_fixed_fee_primary","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An additional fixed fee that can be charged per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/ancillary_fixed_fee_secondary":{"id":"components/schemas/ancillary_fixed_fee_secondary","kind":"json-schema","title":"ancillary_fixed_fee_secondary","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An additional fixed fee that can be charged per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ancillary_fixed_fee_primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is included."},"children":[]}]}]}],"nullable":true}},"components/schemas/basis_points":{"id":"components/schemas/basis_points","kind":"json-schema","title":"basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each card-based "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}]}},"components/schemas/card_3d_secure_fixed_fee":{"id":"components/schemas/card_3d_secure_fixed_fee","kind":"json-schema","title":"card_3d_secure_fixed_fee","data":{"type":"integer","description":"Fee in cents incurred for each 3D Secure Session created.","nullable":true}},"components/schemas/card_account_updater_fixed_fee":{"id":"components/schemas/card_account_updater_fixed_fee","kind":"json-schema","title":"card_account_updater_fixed_fee","data":{"type":"integer","description":"Fee in cents charged per card update received through the Account Updater service. Applies across all card networks.","nullable":true}},"components/schemas/card_cross_border_basis_points":{"id":"components/schemas/card_cross_border_basis_points","kind":"json-schema","title":"card_cross_border_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee charged against the full amount of every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that includes non-US cards. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/card_cross_border_fixed_fee":{"id":"components/schemas/card_cross_border_fixed_fee","kind":"json-schema","title":"card_cross_border_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents charged against every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that includes non-US cards."},"children":[]}]}]}],"nullable":true}},"components/schemas/card_name_verification_fixed_fee":{"id":"components/schemas/card_name_verification_fixed_fee","kind":"json-schema","title":"card_name_verification_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents charged when verifying the name on a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a Payment Instrument or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on verifications."},"children":[]}]}]}],"nullable":true}},"components/schemas/card_network_token_fixed_fee":{"id":"components/schemas/card_network_token_fixed_fee","kind":"json-schema","title":"card_network_token_fixed_fee","data":{"type":"integer","description":"Fee in cents charged per network token successfully created. Supported on Visa and Mastercard only.","nullable":true}},"components/schemas/cash_app_pay_basis_points":{"id":"components/schemas/cash_app_pay_basis_points","kind":"json-schema","title":"cash_app_pay_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each Cash App Pay Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/cash_app_pay_fixed_fee":{"id":"components/schemas/cash_app_pay_fixed_fee","kind":"json-schema","title":"cash_app_pay_fixed_fee","data":{"type":"integer","description":"Fee in cents incurred for each individual Cash App Pay Transfer.","nullable":true}},"components/schemas/charge_all_authorization_requests":{"id":"components/schemas/charge_all_authorization_requests","kind":"json-schema","title":"charge_all_authorization_requests","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to charge the fixed fee on authorizations that fail, are voided, or expire. Captured authorizations are charged using the basis points and fixed fees already on the Fee Profile."},"children":[]}]}]}],"nullable":true}},"components/schemas/charge_all_reversal_requests":{"id":"components/schemas/charge_all_reversal_requests","kind":"json-schema","title":"charge_all_reversal_requests","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to charge the fixed fee on refunds, both successful and failed. Includes bank reversals."},"children":[]}]}]}],"nullable":true}},"components/schemas/charge_all_transfer_requests":{"id":"components/schemas/charge_all_transfer_requests","kind":"json-schema","title":"charge_all_transfer_requests","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to charge the fixed fee on failed sales and captures. Successful sales and captures are always charged the fixed fee."},"children":[]}]}]}],"nullable":true}},"components/schemas/charge_dues_assessments":{"id":"components/schemas/charge_dues_assessments","kind":"json-schema","title":"charge_dues_assessments","data":{"type":"boolean","description":"Whether to pass the dues and assessment fees levied by all applicable card brands (e.g., American Express, Discover, Visa, Mastercard).","nullable":true}},"components/schemas/charge_interchange":{"id":"components/schemas/charge_interchange","kind":"json-schema","title":"charge_interchange","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to incur interchange fees for card-based "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/compliance_forms_overdue_fixed_fee":{"id":"components/schemas/compliance_forms_overdue_fixed_fee","kind":"json-schema","title":"compliance_forms_overdue_fixed_fee","data":{"type":"integer","description":"Fee in cents charged for an overdue compliance form.","nullable":true}},"components/schemas/diners_club_basis_points":{"id":"components/schemas/diners_club_basis_points","kind":"json-schema","title":"diners_club_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each Diners "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/diners_club_charge_interchange":{"id":"components/schemas/diners_club_charge_interchange","kind":"json-schema","title":"diners_club_charge_interchange","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to incur interchange fees for Diners "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/diners_club_fixed_fee":{"id":"components/schemas/diners_club_fixed_fee","kind":"json-schema","title":"diners_club_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual Diners "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/discover_assessments_basis_points":{"id":"components/schemas/discover_assessments_basis_points","kind":"json-schema","title":"discover_assessments_basis_points","data":{"type":"integer","description":"An assessment that applies to gross Discover card transaction volume.","nullable":true}},"components/schemas/discover_basis_points":{"id":"components/schemas/discover_basis_points","kind":"json-schema","title":"discover_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each Discover Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/discover_charge_dues_assessments":{"id":"components/schemas/discover_charge_dues_assessments","kind":"json-schema","title":"discover_charge_dues_assessments","data":{"type":"integer","description":"A fee associated with Discover's assessment of dues or ongoing charges for services provided through the Discover payment network.","nullable":true}},"components/schemas/discover_charge_interchange":{"id":"components/schemas/discover_charge_interchange","kind":"json-schema","title":"discover_charge_interchange","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to incur interchange fees for Discover "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/discover_data_usage_fixed_fee":{"id":"components/schemas/discover_data_usage_fixed_fee","kind":"json-schema","title":"discover_data_usage_fixed_fee","data":{"type":"integer","description":"Applies to all U.S.-based authorization transactions.","nullable":true}},"components/schemas/discover_externally_funded_basis_points":{"id":"components/schemas/discover_externally_funded_basis_points","kind":"json-schema","title":"discover_externally_funded_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each Discover externally funded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/discover_externally_funded_fixed_fee":{"id":"components/schemas/discover_externally_funded_fixed_fee","kind":"json-schema","title":"discover_externally_funded_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual Discover externally funded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/discover_fixed_fee":{"id":"components/schemas/discover_fixed_fee","kind":"json-schema","title":"discover_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual Discover "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/discover_network_authorization_fixed_fee":{"id":"components/schemas/discover_network_authorization_fixed_fee","kind":"json-schema","title":"discover_network_authorization_fixed_fee","data":{"type":"integer","description":"This fee will apply to all Discover network authorizations and will replace the previously assessed Data Transmission.","nullable":true}},"components/schemas/dispute_fixed_fee":{"id":"components/schemas/dispute_fixed_fee","kind":"json-schema","title":"dispute_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee applied when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created or updated to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"nullable":true}},"components/schemas/eft_basis_points_fee_limit":{"id":"components/schemas/eft_basis_points_fee_limit","kind":"json-schema","title":"eft_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum percentage-based fee (in cents) incurred for each individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/eft_basis_points":{"id":"components/schemas/eft_basis_points","kind":"json-schema","title":"eft_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage-based fee applied to the total amount of an EFT sale. Measured in basis points, where 1 basis point equals 0.01% (e.g., 100 basis points = 1%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/eft_credit_return_fixed_fee":{"id":"components/schemas/eft_credit_return_fixed_fee","kind":"json-schema","title":"eft_credit_return_fixed_fee","data":{"type":"integer","description":"A fixed fee (in cents) charged to the merchant for processing an EFT credit return.","nullable":true}},"components/schemas/eft_debit_return_fixed_fee":{"id":"components/schemas/eft_debit_return_fixed_fee","kind":"json-schema","title":"eft_debit_return_fixed_fee","data":{"type":"integer","description":"A fixed fee (in cents) charged to the seller for processing an EFT debit return.","nullable":true}},"components/schemas/eft_fixed_fee":{"id":"components/schemas/eft_fixed_fee","kind":"json-schema","title":"eft_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flat fee (in cents) incurred for each individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made from an EFT sale."},"children":[]}]}]}],"nullable":true}},"components/schemas/eft_validation_plaid_fixed_fee":{"id":"components/schemas/eft_validation_plaid_fixed_fee","kind":"json-schema","title":"eft_validation_plaid_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents charged when a CAD bank account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created using Plaid."},"children":[]}]}]}],"nullable":true}},"components/schemas/externally_funded_basis_points":{"id":"components/schemas/externally_funded_basis_points","kind":"json-schema","title":"externally_funded_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage-based fee applied to the total amount of each externally funded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Measured in basis points, where 1 basis point equals 0.01%."},"children":[]}]}]}],"nullable":true}},"components/schemas/externally_funded_fixed_fee":{"id":"components/schemas/externally_funded_fixed_fee","kind":"json-schema","title":"externally_funded_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fixed fee (in cents) incurred for each individual externally funded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/fixed_fee":{"id":"components/schemas/fixed_fee","kind":"json-schema","title":"fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual card-based "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/gross_monthly_fees_ach_basis_points":{"id":"components/schemas/gross_monthly_fees_ach_basis_points","kind":"json-schema","title":"gross_monthly_fees_ach_basis_points","data":{"type":"integer","description":"The total amount of ACH (eCheck) basis point fees charged over a month.","nullable":true}},"components/schemas/gross_monthly_fees_ach_fixed_fee":{"id":"components/schemas/gross_monthly_fees_ach_fixed_fee","kind":"json-schema","title":"gross_monthly_fees_ach_fixed_fee","data":{"type":"integer","description":"The total amount of ACH (eCheck) fixed fees charged over a month.","nullable":true}},"components/schemas/gross_monthly_fees_card_basis_points":{"id":"components/schemas/gross_monthly_fees_card_basis_points","kind":"json-schema","title":"gross_monthly_fees_card_basis_points","data":{"type":"integer","description":"The total amount of card basis point fees charged over a month.","nullable":true}},"components/schemas/gross_monthly_fees_card_fixed_fee":{"id":"components/schemas/gross_monthly_fees_card_fixed_fee","kind":"json-schema","title":"gross_monthly_fees_card_fixed_fee","data":{"type":"integer","description":"The total amount of card fixed fees charged over a month.","nullable":true}},"components/schemas/gross_monthly_fees_eft_basis_points":{"id":"components/schemas/gross_monthly_fees_eft_basis_points","kind":"json-schema","title":"gross_monthly_fees_eft_basis_points","data":{"type":"integer","description":"The total amount of EFT basis point fees charged over a month.","nullable":true}},"components/schemas/gross_monthly_fees_eft_fixed_fee":{"id":"components/schemas/gross_monthly_fees_eft_fixed_fee","kind":"json-schema","title":"gross_monthly_fees_eft_fixed_fee","data":{"type":"integer","description":"The total amount of EFT fixed fees charged over a month.","nullable":true}},"components/schemas/interac_basis_points":{"id":"components/schemas/interac_basis_points","kind":"json-schema","title":"interac_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each Interac Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/interac_fixed_fee":{"id":"components/schemas/interac_fixed_fee","kind":"json-schema","title":"interac_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual Interac "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/invoice_ach_basis_points":{"id":"components/schemas/invoice_ach_basis_points","kind":"json-schema","title":"invoice_ach_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each ACH "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a buyer pays an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/invoice_ach_basis_points_fee_limit":{"id":"components/schemas/invoice_ach_basis_points_fee_limit","kind":"json-schema","title":"invoice_ach_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum ACH basis points fee (in cents) incurred for each individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a buyer pays an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/invoice_ach_fixed_fee":{"id":"components/schemas/invoice_ach_fixed_fee","kind":"json-schema","title":"invoice_ach_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flat fee (in cents) incurred for each individual ACH "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a buyer pays an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/invoice_card_basis_points":{"id":"components/schemas/invoice_card_basis_points","kind":"json-schema","title":"invoice_card_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each card-based "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a buyer pays an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/invoice_card_fixed_fee":{"id":"components/schemas/invoice_card_fixed_fee","kind":"json-schema","title":"invoice_card_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flat fee (in cents) incurred for each individual card-based "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a buyer pays an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/invoice_eft_basis_points":{"id":"components/schemas/invoice_eft_basis_points","kind":"json-schema","title":"invoice_eft_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each EFT "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a buyer pays an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/invoice_eft_basis_points_fee_limit":{"id":"components/schemas/invoice_eft_basis_points_fee_limit","kind":"json-schema","title":"invoice_eft_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum EFT basis points fee (in cents) incurred for each individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a buyer pays an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/invoice_eft_fixed_fee":{"id":"components/schemas/invoice_eft_fixed_fee","kind":"json-schema","title":"invoice_eft_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flat fee (in cents) incurred for each individual EFT "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a buyer pays an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Invoice"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/jcb_basis_points":{"id":"components/schemas/jcb_basis_points","kind":"json-schema","title":"jcb_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each JCB Transfer. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/jcb_charge_interchange":{"id":"components/schemas/jcb_charge_interchange","kind":"json-schema","title":"jcb_charge_interchange","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to incur interchange fees for JCB "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/jcb_fixed_fee":{"id":"components/schemas/jcb_fixed_fee","kind":"json-schema","title":"jcb_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual JCB "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/mastercard_acquirer_fees_basis_points":{"id":"components/schemas/mastercard_acquirer_fees_basis_points","kind":"json-schema","title":"mastercard_acquirer_fees_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee assessed on a business’s gross MasterCard processing volume. This fee varies per acquirer based on MasterCard’s assessed charge as it’s distributed across the acquirer’s portfolio of merchants. Generally, this fee is a fraction of a basis point. For example, 0.0045%, 0.0075%, etc. are examples of a likely fee."},"children":[]}]}]}],"nullable":true}},"components/schemas/mastercard_assessments_over1k_basis_points":{"id":"components/schemas/mastercard_assessments_over1k_basis_points","kind":"json-schema","title":"mastercard_assessments_over1k_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee applied to Mastercard credit sale transactions greater than $1,000."},"children":[]}]}]}],"nullable":true}},"components/schemas/mastercard_assessments_under1k_basis_points":{"id":"components/schemas/mastercard_assessments_under1k_basis_points","kind":"json-schema","title":"mastercard_assessments_under1k_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee applied to Mastercard transactions less than or equal to $1,000."},"children":[]}]}]}],"nullable":true}},"components/schemas/mastercard_basis_points":{"id":"components/schemas/mastercard_basis_points","kind":"json-schema","title":"mastercard_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each MasterCard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/mastercard_charge_dues_assessments":{"id":"components/schemas/mastercard_charge_dues_assessments","kind":"json-schema","title":"mastercard_charge_dues_assessments","data":{"type":"integer","description":"A fee associated with MasterCard's assessment of dues or ongoing charges for services provided through the MasterCard payment network.","nullable":true}},"components/schemas/mastercard_charge_interchange":{"id":"components/schemas/mastercard_charge_interchange","kind":"json-schema","title":"mastercard_charge_interchange","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to incur interchange fees for MasterCard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/mastercard_fixed_fee":{"id":"components/schemas/mastercard_fixed_fee","kind":"json-schema","title":"mastercard_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual MasterCard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/payment_instrument_tokenization_fixed_fee":{"id":"components/schemas/payment_instrument_tokenization_fixed_fee","kind":"json-schema","title":"payment_instrument_tokenization_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fee in cents charged when Finix tokenizes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/recurring_monthly_fixed_cycle_day":{"id":"components/schemas/recurring_monthly_fixed_cycle_day","kind":"json-schema","title":"recurring_monthly_fixed_cycle_day","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring_monthly_fixed_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is charged. If the configured day exceeds the number of days in a given month, the fee is charged on the last day of that month."},"children":[]}]}]}],"minimum":1,"maximum":31,"nullable":true}},"components/schemas/recurring_monthly_fixed_fee":{"id":"components/schemas/recurring_monthly_fixed_fee","kind":"json-schema","title":"recurring_monthly_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A monthly recurring fee (in cents) that allows the passthrough of fees to sub-merchants on a monthly cadence. The fee is charged on the day of the month set by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring_monthly_fixed_cycle_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/recurring_yearly_fixed_cycle_day":{"id":"components/schemas/recurring_yearly_fixed_cycle_day","kind":"json-schema","title":"recurring_yearly_fixed_cycle_day","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Day of the month ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring_yearly_fixed_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is charged, within the month set by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring_yearly_fixed_cycle_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the configured day exceeds the number of days in that month, the fee is charged on the last day of that month."},"children":[]}]}]}],"minimum":1,"maximum":31,"nullable":true}},"components/schemas/recurring_yearly_fixed_cycle_month":{"id":"components/schemas/recurring_yearly_fixed_cycle_month","kind":"json-schema","title":"recurring_yearly_fixed_cycle_month","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Month of the year ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring_yearly_fixed_fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is charged. Used together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring_yearly_fixed_cycle_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to determine the yearly charge date."},"children":[]}]}]}],"minimum":1,"maximum":12,"nullable":true}},"components/schemas/recurring_yearly_fixed_fee":{"id":"components/schemas/recurring_yearly_fixed_fee","kind":"json-schema","title":"recurring_yearly_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A yearly recurring fee (in cents) that allows the passthrough of fees to sub-merchants on a yearly cadence. The fee is charged on the date set by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring_yearly_fixed_cycle_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurring_yearly_fixed_cycle_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_ach_basis_points_fee_limit":{"id":"components/schemas/settlement_funding_transfer_ach_basis_points_fee_limit","kind":"json-schema","title":"settlement_funding_transfer_ach_basis_points_fee_limit","data":{"type":"integer","description":"The maximum percentage-based fee (in cents) incurred for each individual Settlement Funding Transfer (ACH).","nullable":true}},"components/schemas/settlement_funding_transfer_ach_basis_points":{"id":"components/schemas/settlement_funding_transfer_ach_basis_points","kind":"json-schema","title":"settlement_funding_transfer_ach_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A percentage-based fee applied to ACH transfers related to settlement funding. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_ach_credit_return_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_ach_credit_return_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_ach_credit_return_fixed_fee","data":{"type":"integer","description":"A fixed fee (in cents) charged to the platform or seller when receiving a credit return related to a Settlement Funding Transfer (ACH).","nullable":true}},"components/schemas/settlement_funding_transfer_ach_debit_return_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_ach_debit_return_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_ach_debit_return_fixed_fee","data":{"type":"integer","description":"A fixed fee (in cents) charged to the platform or seller when receiving a Debit Return related to a Settlement Funding Transfer (ACH).","nullable":true}},"components/schemas/settlement_funding_transfer_ach_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_ach_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_ach_fixed_fee","data":{"type":"integer","description":"A flat fee (in cents) incurred for each individual Settlement Funding Transfer (ACH).","nullable":true}},"components/schemas/settlement_funding_transfer_eft_basis_points_fee_limit":{"id":"components/schemas/settlement_funding_transfer_eft_basis_points_fee_limit","kind":"json-schema","title":"settlement_funding_transfer_eft_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum percentage-based fee (in cents) incurred for each individual settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made via an EFT."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_eft_basis_points":{"id":"components/schemas/settlement_funding_transfer_eft_basis_points","kind":"json-schema","title":"settlement_funding_transfer_eft_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage-based fee applied to the total amount of a settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made via an EFT from a Canadian-based bank account. Measured in basis points, where 1 basis point equals 0.01% (e.g., 100 basis points = 1%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_eft_credit_return_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_eft_credit_return_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_eft_credit_return_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fixed fee (in cents) charged for processing a Credit Return related to a settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This occurs when funds are returned from a Canadian-based bank account back to the seller's account via EFT."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_eft_debit_return_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_eft_debit_return_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_eft_debit_return_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A fixed fee (in cents) charged for processing a Debit Return related to a settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This occurs when funds are returned from the seller's account to a Canadian-based bank account via EFT due to a payment failure or reversal."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_eft_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_eft_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_eft_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flat fee (in cents) incurred for each settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made via an EFT from a Canadian-based bank account. This fee is independent of the payment amount."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":{"id":"components/schemas/settlement_funding_transfer_instant_payout_card_basis_points_fee_limit","kind":"json-schema","title":"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum percentage-based fee (in cents) incurred for each individual settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made as an instant payout to a card."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_instant_payout_card_basis_points":{"id":"components/schemas/settlement_funding_transfer_instant_payout_card_basis_points","kind":"json-schema","title":"settlement_funding_transfer_instant_payout_card_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage-based fee applied to the total amount of a settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made as an instant payout to a card. Measured in basis points, where 1 basis point equals 0.01% (e.g., 100 basis points = 1%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_instant_payout_card_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_instant_payout_card_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_instant_payout_card_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flat fee (in cents) incurred for each settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made as an instant payout to a card."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_noc_credit_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_noc_credit_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_noc_credit_fixed_fee","data":{"type":"integer","description":"A fixed fee (in cents) charged for processing a Notification of Change (NOC) related to a credit transaction in settlement funding transfers.","nullable":true}},"components/schemas/settlement_funding_transfer_noc_debit_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_noc_debit_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_noc_debit_fixed_fee","data":{"type":"integer","description":"A fixed fee (in cents) charged for processing a Notification of Change (NOC) related to a debit transaction in settlement funding transfers.","nullable":true}},"components/schemas/settlement_funding_transfer_same_day_ach_basis_points_fee_limit":{"id":"components/schemas/settlement_funding_transfer_same_day_ach_basis_points_fee_limit","kind":"json-schema","title":"settlement_funding_transfer_same_day_ach_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum percentage-based fee (in cents) incurred for each individual settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made via same-day ACH."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_same_day_ach_basis_points":{"id":"components/schemas/settlement_funding_transfer_same_day_ach_basis_points","kind":"json-schema","title":"settlement_funding_transfer_same_day_ach_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of a settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made via same-day ACH. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/settlement_funding_transfer_same_day_ach_fixed_fee":{"id":"components/schemas/settlement_funding_transfer_same_day_ach_fixed_fee","kind":"json-schema","title":"settlement_funding_transfer_same_day_ach_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A flat fee (in cents) incurred for each settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" made via same-day ACH."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_ach_basis_points":{"id":"components/schemas/subscription_ach_basis_points","kind":"json-schema","title":"subscription_ach_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage-based fee incurred against the full amount of each ACH Direct Debit transaction created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_ach_basis_points_fee_limit":{"id":"components/schemas/subscription_ach_basis_points_fee_limit","kind":"json-schema","title":"subscription_ach_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_ach_basis_points"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee (in cents) incurred for each individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_ach_fixed_fee":{"id":"components/schemas/subscription_ach_fixed_fee","kind":"json-schema","title":"subscription_ach_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee in cents incurred for each individual ACH Direct Debit transaction created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_card_basis_points":{"id":"components/schemas/subscription_card_basis_points","kind":"json-schema","title":"subscription_card_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage-based fee incurred against the full amount of each card-based transaction created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_card_fixed_fee":{"id":"components/schemas/subscription_card_fixed_fee","kind":"json-schema","title":"subscription_card_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage-based fee incurred against the full amount of each EFT transaction created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_eft_basis_points":{"id":"components/schemas/subscription_eft_basis_points","kind":"json-schema","title":"subscription_eft_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The percentage-based fee incurred against the full amount of each EFT transaction created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_eft_basis_points_fee_limit":{"id":"components/schemas/subscription_eft_basis_points_fee_limit","kind":"json-schema","title":"subscription_eft_basis_points_fee_limit","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subscription_eft_basis_points"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fee (in cents) incurred for each individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_eft_fixed_fee":{"id":"components/schemas/subscription_eft_fixed_fee","kind":"json-schema","title":"subscription_eft_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fee in cents incurred for each individual EFT transaction created from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/tap_to_pay_basis_points":{"id":"components/schemas/tap_to_pay_basis_points","kind":"json-schema","title":"tap_to_pay_basis_points","data":{"type":"integer","description":"The amount to charge for an iOS and Android Tap to Pay transaction in basis points.","nullable":true}},"components/schemas/tap_to_pay_fixed_fee":{"id":"components/schemas/tap_to_pay_fixed_fee","kind":"json-schema","title":"tap_to_pay_fixed_fee","data":{"type":"integer","description":"The fixed amount in cents to charge for an iOS and Android Tap to Pay transaction.","nullable":true}},"components/schemas/third_party_gateway_cybersource_basis_points":{"id":"components/schemas/third_party_gateway_cybersource_basis_points","kind":"json-schema","title":"third_party_gateway_cybersource_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each Transfer processed through the CyberSource gateway. Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)."},"children":[]}]}]}],"nullable":true}},"components/schemas/third_party_gateway_cybersource_fixed_fee":{"id":"components/schemas/third_party_gateway_cybersource_fixed_fee","kind":"json-schema","title":"third_party_gateway_cybersource_fixed_fee","data":{"type":"integer","description":"Fee in cents incurred for each Transfer processed through the CyberSource gateway.","nullable":true}},"components/schemas/visa_acquirer_processing_fixed_fee":{"id":"components/schemas/visa_acquirer_processing_fixed_fee","kind":"json-schema","title":"visa_acquirer_processing_fixed_fee","data":{"type":"integer","description":"Applies to all U.S.-based credit card authorizations acquired in the U.S., regardless of where the issuer/cardholder is located. If your business is based in the U.S., the acquirer processing fee will apply to all Visa credit card authorizations.","nullable":true}},"components/schemas/visa_assessments_basis_points":{"id":"components/schemas/visa_assessments_basis_points","kind":"json-schema","title":"visa_assessments_basis_points","data":{"type":"integer","description":"Applies to all Visa credit transactions.","nullable":true}},"components/schemas/visa_base_II_credit_voucher_fixed_fee":{"id":"components/schemas/visa_base_II_credit_voucher_fixed_fee","kind":"json-schema","title":"visa_base_II_credit_voucher_fixed_fee","data":{"type":"integer","description":"Applies to all U.S.-based refunds.","nullable":true}},"components/schemas/visa_base_II_system_file_transmission_fixed_fee":{"id":"components/schemas/visa_base_II_system_file_transmission_fixed_fee","kind":"json-schema","title":"visa_base_II_system_file_transmission_fixed_fee","data":{"type":"integer","description":"Applies to all Visa transactions and is charged in addition to other transaction-based assessments.","nullable":true}},"components/schemas/visa_basis_points":{"id":"components/schemas/visa_basis_points","kind":"json-schema","title":"visa_basis_points","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percentage-based fee incurred against the full amount of each Visa "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Calculated as one hundredth of one percent (1 basis point = .0001 or .01%)"},"children":[]}]}]}],"nullable":true}},"components/schemas/visa_charge_dues_assessments":{"id":"components/schemas/visa_charge_dues_assessments","kind":"json-schema","title":"visa_charge_dues_assessments","data":{"type":"integer","description":"A fee associated with Visa's assessment of dues or ongoing charges for services provided through the Visa payment network.","nullable":true}},"components/schemas/visa_charge_interchange":{"id":"components/schemas/visa_charge_interchange","kind":"json-schema","title":"visa_charge_interchange","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to incur interchange fees for Visa "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/visa_credit_voucher_fixed_fee":{"id":"components/schemas/visa_credit_voucher_fixed_fee","kind":"json-schema","title":"visa_credit_voucher_fixed_fee","data":{"type":"integer","description":"Applies to Visa refunds.","nullable":true}},"components/schemas/visa_fixed_fee":{"id":"components/schemas/visa_fixed_fee","kind":"json-schema","title":"visa_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee in cents incurred for each individual Visa "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/visa_kilobyte_access_fixed_fee":{"id":"components/schemas/visa_kilobyte_access_fixed_fee","kind":"json-schema","title":"visa_kilobyte_access_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Charged on each authorization transaction submitted to Visa’s network for settlement."},"children":[]}]}]}],"nullable":true}},"components/schemas/fee_profile":{"id":"components/schemas/fee_profile","kind":"json-schema","title":"Fee Profile","data":{"title":"Fee Profile","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"ach_basis_points_fee_limit":{"$ref":"#/components/schemas/ach_basis_points_fee_limit"},"ach_basis_points":{"$ref":"#/components/schemas/ach_basis_points"},"ach_credit_return_fixed_fee":{"$ref":"#/components/schemas/ach_credit_return_fixed_fee"},"ach_debit_return_fixed_fee":{"$ref":"#/components/schemas/ach_debit_return_fixed_fee"},"ach_fixed_fee":{"$ref":"#/components/schemas/ach_fixed_fee"},"ach_notice_of_change_credit_fixed_fee":{"$ref":"#/components/schemas/ach_notice_of_change_credit_fixed_fee"},"ach_notice_of_change_debit_fixed_fee":{"$ref":"#/components/schemas/ach_notice_of_change_debit_fixed_fee"},"ach_validation_plaid_fixed_fee":{"$ref":"#/components/schemas/ach_validation_plaid_fixed_fee"},"afterpay_basis_points":{"$ref":"#/components/schemas/afterpay_basis_points"},"afterpay_fixed_fee":{"$ref":"#/components/schemas/afterpay_fixed_fee"},"american_express_assessment_basis_points":{"$ref":"#/components/schemas/american_express_assessment_basis_points"},"american_express_basis_points":{"$ref":"#/components/schemas/american_express_basis_points"},"american_express_charge_dues_assessments":{"$ref":"#/components/schemas/american_express_charge_dues_assessments"},"american_express_charge_interchange":{"$ref":"#/components/schemas/american_express_charge_interchange"},"american_express_externally_funded_basis_points":{"$ref":"#/components/schemas/american_express_externally_funded_basis_points"},"american_express_externally_funded_fixed_fee":{"$ref":"#/components/schemas/american_express_externally_funded_fixed_fee"},"american_express_fixed_fee":{"$ref":"#/components/schemas/american_express_fixed_fee"},"ancillary_fixed_fee_primary":{"$ref":"#/components/schemas/ancillary_fixed_fee_primary"},"ancillary_fixed_fee_secondary":{"$ref":"#/components/schemas/ancillary_fixed_fee_secondary"},"application":{"$ref":"#/components/schemas/application_id"},"basis_points":{"$ref":"#/components/schemas/basis_points"},"card_3d_secure_fixed_fee":{"$ref":"#/components/schemas/card_3d_secure_fixed_fee"},"card_account_updater_fixed_fee":{"$ref":"#/components/schemas/card_account_updater_fixed_fee"},"card_cross_border_basis_points":{"$ref":"#/components/schemas/card_cross_border_basis_points"},"card_cross_border_fixed_fee":{"$ref":"#/components/schemas/card_cross_border_fixed_fee"},"card_name_verification_fixed_fee":{"$ref":"#/components/schemas/card_name_verification_fixed_fee"},"card_network_token_fixed_fee":{"$ref":"#/components/schemas/card_network_token_fixed_fee"},"cash_app_pay_basis_points":{"$ref":"#/components/schemas/cash_app_pay_basis_points"},"cash_app_pay_fixed_fee":{"$ref":"#/components/schemas/cash_app_pay_fixed_fee"},"charge_all_authorization_requests":{"$ref":"#/components/schemas/charge_all_authorization_requests"},"charge_all_reversal_requests":{"$ref":"#/components/schemas/charge_all_reversal_requests"},"charge_all_transfer_requests":{"$ref":"#/components/schemas/charge_all_transfer_requests"},"charge_dues_assessments":{"$ref":"#/components/schemas/charge_dues_assessments"},"charge_interchange":{"$ref":"#/components/schemas/charge_interchange"},"compliance_forms_overdue_fixed_fee":{"$ref":"#/components/schemas/compliance_forms_overdue_fixed_fee"},"diners_club_basis_points":{"$ref":"#/components/schemas/diners_club_basis_points"},"diners_club_charge_interchange":{"$ref":"#/components/schemas/diners_club_charge_interchange"},"diners_club_fixed_fee":{"$ref":"#/components/schemas/diners_club_fixed_fee"},"discover_assessments_basis_points":{"$ref":"#/components/schemas/discover_assessments_basis_points"},"discover_basis_points":{"$ref":"#/components/schemas/discover_basis_points"},"discover_charge_dues_assessments":{"$ref":"#/components/schemas/discover_charge_dues_assessments"},"discover_charge_interchange":{"$ref":"#/components/schemas/discover_charge_interchange"},"discover_data_usage_fixed_fee":{"$ref":"#/components/schemas/discover_data_usage_fixed_fee"},"discover_externally_funded_basis_points":{"$ref":"#/components/schemas/discover_externally_funded_basis_points"},"discover_externally_funded_fixed_fee":{"$ref":"#/components/schemas/discover_externally_funded_fixed_fee"},"discover_fixed_fee":{"$ref":"#/components/schemas/discover_fixed_fee"},"discover_network_authorization_fixed_fee":{"$ref":"#/components/schemas/discover_network_authorization_fixed_fee"},"dispute_fixed_fee":{"$ref":"#/components/schemas/dispute_fixed_fee"},"dispute_inquiry_fixed_fee":{"$ref":"#/components/schemas/dispute_fixed_fee"},"eft_basis_points_fee_limit":{"$ref":"#/components/schemas/eft_basis_points_fee_limit"},"eft_basis_points":{"$ref":"#/components/schemas/eft_basis_points"},"eft_credit_return_fixed_fee":{"$ref":"#/components/schemas/eft_credit_return_fixed_fee"},"eft_debit_return_fixed_fee":{"$ref":"#/components/schemas/eft_debit_return_fixed_fee"},"eft_fixed_fee":{"$ref":"#/components/schemas/eft_fixed_fee"},"eft_validation_plaid_fixed_fee":{"$ref":"#/components/schemas/eft_validation_plaid_fixed_fee"},"externally_funded_basis_points":{"$ref":"#/components/schemas/externally_funded_basis_points"},"externally_funded_fixed_fee":{"$ref":"#/components/schemas/externally_funded_fixed_fee"},"fixed_fee":{"$ref":"#/components/schemas/fixed_fee"},"gross_monthly_fees_ach_basis_points":{"$ref":"#/components/schemas/gross_monthly_fees_ach_basis_points"},"gross_monthly_fees_ach_fixed_fee":{"$ref":"#/components/schemas/gross_monthly_fees_ach_fixed_fee"},"gross_monthly_fees_card_basis_points":{"$ref":"#/components/schemas/gross_monthly_fees_card_basis_points"},"gross_monthly_fees_card_fixed_fee":{"$ref":"#/components/schemas/gross_monthly_fees_card_fixed_fee"},"gross_monthly_fees_eft_basis_points":{"$ref":"#/components/schemas/gross_monthly_fees_eft_basis_points"},"gross_monthly_fees_eft_fixed_fee":{"$ref":"#/components/schemas/gross_monthly_fees_eft_fixed_fee"},"interac_basis_points":{"$ref":"#/components/schemas/interac_basis_points"},"interac_fixed_fee":{"$ref":"#/components/schemas/interac_fixed_fee"},"invoice_ach_basis_points":{"$ref":"#/components/schemas/invoice_ach_basis_points"},"invoice_ach_basis_points_fee_limit":{"$ref":"#/components/schemas/invoice_ach_basis_points_fee_limit"},"invoice_ach_fixed_fee":{"$ref":"#/components/schemas/invoice_ach_fixed_fee"},"invoice_card_basis_points":{"$ref":"#/components/schemas/invoice_card_basis_points"},"invoice_card_fixed_fee":{"$ref":"#/components/schemas/invoice_card_fixed_fee"},"invoice_eft_basis_points":{"$ref":"#/components/schemas/invoice_eft_basis_points"},"invoice_eft_basis_points_fee_limit":{"$ref":"#/components/schemas/invoice_eft_basis_points_fee_limit"},"invoice_eft_fixed_fee":{"$ref":"#/components/schemas/invoice_eft_fixed_fee"},"jcb_basis_points":{"$ref":"#/components/schemas/jcb_basis_points"},"jcb_charge_interchange":{"$ref":"#/components/schemas/jcb_charge_interchange"},"jcb_fixed_fee":{"$ref":"#/components/schemas/jcb_fixed_fee"},"mastercard_acquirer_fees_basis_points":{"$ref":"#/components/schemas/mastercard_acquirer_fees_basis_points"},"mastercard_assessments_over1k_basis_points":{"$ref":"#/components/schemas/mastercard_assessments_over1k_basis_points"},"mastercard_assessments_under1k_basis_points":{"$ref":"#/components/schemas/mastercard_assessments_under1k_basis_points"},"mastercard_basis_points":{"$ref":"#/components/schemas/mastercard_basis_points"},"mastercard_charge_dues_assessments":{"$ref":"#/components/schemas/mastercard_charge_dues_assessments"},"mastercard_charge_interchange":{"$ref":"#/components/schemas/mastercard_charge_interchange"},"mastercard_fixed_fee":{"$ref":"#/components/schemas/mastercard_fixed_fee"},"payment_instrument_tokenization_fixed_fee":{"$ref":"#/components/schemas/payment_instrument_tokenization_fixed_fee"},"qualified_tiers":{"type":"object","description":"The top of the qualified tier tree.","nullable":true},"recurring_monthly_fixed_cycle_day":{"$ref":"#/components/schemas/recurring_monthly_fixed_cycle_day"},"recurring_monthly_fixed_fee":{"$ref":"#/components/schemas/recurring_monthly_fixed_fee"},"recurring_yearly_fixed_cycle_day":{"$ref":"#/components/schemas/recurring_yearly_fixed_cycle_day"},"recurring_yearly_fixed_cycle_month":{"$ref":"#/components/schemas/recurring_yearly_fixed_cycle_month"},"recurring_yearly_fixed_fee":{"$ref":"#/components/schemas/recurring_yearly_fixed_fee"},"rounding_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AGGREGATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to round after the settlement calculation. By default, rounding happens before the sum of the settlement calculation (i.e., round each fee transfer)."},"children":[]}]}]}],"enum":["TRANSACTION","AGGREGATE"]},"settlement_funding_transfer_ach_basis_points_fee_limit":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_basis_points_fee_limit"},"settlement_funding_transfer_ach_basis_points":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_basis_points"},"settlement_funding_transfer_ach_credit_return_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_credit_return_fixed_fee"},"settlement_funding_transfer_ach_debit_return_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_debit_return_fixed_fee"},"settlement_funding_transfer_ach_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_fixed_fee"},"settlement_funding_transfer_eft_basis_points_fee_limit":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_basis_points_fee_limit"},"settlement_funding_transfer_eft_basis_points":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_basis_points"},"settlement_funding_transfer_eft_credit_return_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_credit_return_fixed_fee"},"settlement_funding_transfer_eft_debit_return_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_debit_return_fixed_fee"},"settlement_funding_transfer_eft_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_fixed_fee"},"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":{"$ref":"#/components/schemas/settlement_funding_transfer_instant_payout_card_basis_points_fee_limit"},"settlement_funding_transfer_instant_payout_card_basis_points":{"$ref":"#/components/schemas/settlement_funding_transfer_instant_payout_card_basis_points"},"settlement_funding_transfer_instant_payout_card_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_instant_payout_card_fixed_fee"},"settlement_funding_transfer_noc_credit_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_noc_credit_fixed_fee"},"settlement_funding_transfer_noc_debit_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_noc_debit_fixed_fee"},"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":{"$ref":"#/components/schemas/settlement_funding_transfer_same_day_ach_basis_points_fee_limit"},"settlement_funding_transfer_same_day_ach_basis_points":{"$ref":"#/components/schemas/settlement_funding_transfer_same_day_ach_basis_points"},"settlement_funding_transfer_same_day_ach_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_same_day_ach_fixed_fee"},"subscription_ach_basis_points":{"$ref":"#/components/schemas/subscription_ach_basis_points"},"subscription_ach_basis_points_fee_limit":{"$ref":"#/components/schemas/subscription_ach_basis_points_fee_limit"},"subscription_ach_fixed_fee":{"$ref":"#/components/schemas/subscription_ach_fixed_fee"},"subscription_card_basis_points":{"$ref":"#/components/schemas/subscription_card_basis_points"},"subscription_card_fixed_fee":{"$ref":"#/components/schemas/subscription_card_fixed_fee"},"subscription_eft_basis_points":{"$ref":"#/components/schemas/subscription_eft_basis_points"},"subscription_eft_basis_points_fee_limit":{"$ref":"#/components/schemas/subscription_eft_basis_points_fee_limit"},"subscription_eft_fixed_fee":{"$ref":"#/components/schemas/subscription_eft_fixed_fee"},"tap_to_pay_basis_points":{"$ref":"#/components/schemas/tap_to_pay_basis_points"},"tap_to_pay_fixed_fee":{"$ref":"#/components/schemas/tap_to_pay_fixed_fee"},"third_party_gateway_cybersource_basis_points":{"$ref":"#/components/schemas/third_party_gateway_cybersource_basis_points"},"third_party_gateway_cybersource_fixed_fee":{"$ref":"#/components/schemas/third_party_gateway_cybersource_fixed_fee"},"visa_acquirer_processing_fixed_fee":{"$ref":"#/components/schemas/visa_acquirer_processing_fixed_fee"},"visa_assessments_basis_points":{"$ref":"#/components/schemas/visa_assessments_basis_points"},"visa_base_II_credit_voucher_fixed_fee":{"$ref":"#/components/schemas/visa_base_II_credit_voucher_fixed_fee"},"visa_base_II_system_file_transmission_fixed_fee":{"$ref":"#/components/schemas/visa_base_II_system_file_transmission_fixed_fee"},"visa_basis_points":{"$ref":"#/components/schemas/visa_basis_points"},"visa_charge_dues_assessments":{"$ref":"#/components/schemas/visa_charge_dues_assessments"},"visa_charge_interchange":{"$ref":"#/components/schemas/visa_charge_interchange"},"visa_credit_voucher_fixed_fee":{"$ref":"#/components/schemas/visa_credit_voucher_fixed_fee"},"visa_fixed_fee":{"$ref":"#/components/schemas/visa_fixed_fee"},"visa_kilobyte_access_fixed_fee":{"$ref":"#/components/schemas/visa_kilobyte_access_fixed_fee"},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string","minLength":1}}},"application":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}}}}}},"components/schemas/createFeeProfileBlended":{"id":"components/schemas/createFeeProfileBlended","kind":"json-schema","title":"Blended Profile","data":{"type":"object","title":"Blended Profile","properties":{"ach_basis_points":{"$ref":"#/components/schemas/ach_basis_points"},"ach_credit_return_fixed_fee":{"$ref":"#/components/schemas/ach_credit_return_fixed_fee"},"ach_debit_return_fixed_fee":{"$ref":"#/components/schemas/ach_debit_return_fixed_fee"},"ach_fixed_fee":{"$ref":"#/components/schemas/ach_fixed_fee"},"basis_points":{"$ref":"#/components/schemas/basis_points"},"card_cross_border_basis_points":{"$ref":"#/components/schemas/card_cross_border_basis_points"},"dispute_fixed_fee":{"$ref":"#/components/schemas/dispute_fixed_fee"},"fixed_fee":{"$ref":"#/components/schemas/fixed_fee"}}}},"components/schemas/createFeeProfileInterchangePlus":{"id":"components/schemas/createFeeProfileInterchangePlus","kind":"json-schema","title":"Interchange Plus Profile","data":{"type":"object","title":"Interchange Plus Profile","properties":{"ach_basis_points":{"$ref":"#/components/schemas/ach_basis_points"},"ach_credit_return_fixed_fee":{"$ref":"#/components/schemas/ach_credit_return_fixed_fee"},"ach_debit_return_fixed_fee":{"$ref":"#/components/schemas/ach_debit_return_fixed_fee"},"ach_fixed_fee":{"$ref":"#/components/schemas/ach_fixed_fee"},"basis_points":{"$ref":"#/components/schemas/basis_points"},"charge_interchange":{"$ref":"#/components/schemas/charge_interchange"},"dispute_fixed_fee":{"$ref":"#/components/schemas/dispute_fixed_fee"},"fixed_fee":{"$ref":"#/components/schemas/fixed_fee"}}}},"components/schemas/createFeeProfileInterchangePlusDuesAssessments":{"id":"components/schemas/createFeeProfileInterchangePlusDuesAssessments","kind":"json-schema","title":"Interchange Plus and Dues and Assessments","data":{"type":"object","title":"Interchange Plus and Dues and Assessments","properties":{"ach_basis_points":{"$ref":"#/components/schemas/ach_basis_points"},"ach_credit_return_fixed_fee":{"$ref":"#/components/schemas/ach_credit_return_fixed_fee"},"ach_debit_return_fixed_fee":{"$ref":"#/components/schemas/ach_debit_return_fixed_fee"},"ach_fixed_fee":{"$ref":"#/components/schemas/ach_fixed_fee"},"basis_points":{"$ref":"#/components/schemas/basis_points"},"charge_dues_assessments":{"$ref":"#/components/schemas/charge_dues_assessments"},"charge_interchange":{"$ref":"#/components/schemas/charge_interchange"},"dispute_fixed_fee":{"$ref":"#/components/schemas/dispute_fixed_fee"},"fixed_fee":{"$ref":"#/components/schemas/fixed_fee"}}}},"components/schemas/dispute_inquiry_fixed_fee":{"id":"components/schemas/dispute_inquiry_fixed_fee","kind":"json-schema","title":"dispute_inquiry_fixed_fee","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee applied when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created or updated to an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state."},"children":[]}]}]}],"nullable":true}},"components/schemas/createFeeProfile":{"id":"components/schemas/createFeeProfile","kind":"json-schema","title":"All Fields","data":{"type":"object","title":"All Fields","properties":{"ach_basis_points":{"$ref":"#/components/schemas/ach_basis_points"},"ach_basis_points_fee_limit":{"$ref":"#/components/schemas/ach_basis_points_fee_limit"},"ach_credit_return_fixed_fee":{"$ref":"#/components/schemas/ach_credit_return_fixed_fee"},"ach_debit_return_fixed_fee":{"$ref":"#/components/schemas/ach_debit_return_fixed_fee"},"ach_fixed_fee":{"$ref":"#/components/schemas/ach_fixed_fee"},"ach_notice_of_change_credit_fixed_fee":{"$ref":"#/components/schemas/ach_notice_of_change_credit_fixed_fee"},"ach_notice_of_change_debit_fixed_fee":{"$ref":"#/components/schemas/ach_notice_of_change_debit_fixed_fee"},"ach_validation_plaid_fixed_fee":{"$ref":"#/components/schemas/ach_validation_plaid_fixed_fee"},"afterpay_basis_points":{"$ref":"#/components/schemas/afterpay_basis_points"},"afterpay_fixed_fee":{"$ref":"#/components/schemas/afterpay_fixed_fee"},"american_express_assessment_basis_points":{"$ref":"#/components/schemas/american_express_assessment_basis_points"},"american_express_basis_points":{"$ref":"#/components/schemas/american_express_basis_points"},"american_express_charge_dues_assessments":{"$ref":"#/components/schemas/american_express_charge_dues_assessments"},"american_express_charge_interchange":{"$ref":"#/components/schemas/american_express_charge_interchange"},"american_express_externally_funded_basis_points":{"$ref":"#/components/schemas/american_express_externally_funded_basis_points"},"american_express_externally_funded_fixed_fee":{"$ref":"#/components/schemas/american_express_externally_funded_fixed_fee"},"american_express_fixed_fee":{"$ref":"#/components/schemas/american_express_fixed_fee"},"ancillary_fixed_fee_primary":{"$ref":"#/components/schemas/ancillary_fixed_fee_primary"},"ancillary_fixed_fee_secondary":{"$ref":"#/components/schemas/ancillary_fixed_fee_secondary"},"basis_points":{"$ref":"#/components/schemas/basis_points"},"card_3d_secure_fixed_fee":{"$ref":"#/components/schemas/card_3d_secure_fixed_fee"},"card_account_updater_fixed_fee":{"$ref":"#/components/schemas/card_account_updater_fixed_fee"},"card_cross_border_basis_points":{"$ref":"#/components/schemas/card_cross_border_basis_points"},"card_cross_border_fixed_fee":{"$ref":"#/components/schemas/card_cross_border_fixed_fee"},"card_name_verification_fixed_fee":{"$ref":"#/components/schemas/card_name_verification_fixed_fee"},"card_network_token_fixed_fee":{"$ref":"#/components/schemas/card_network_token_fixed_fee"},"cash_app_pay_basis_points":{"$ref":"#/components/schemas/cash_app_pay_basis_points"},"cash_app_pay_fixed_fee":{"$ref":"#/components/schemas/cash_app_pay_fixed_fee"},"charge_all_authorization_requests":{"$ref":"#/components/schemas/charge_all_authorization_requests"},"charge_all_reversal_requests":{"$ref":"#/components/schemas/charge_all_reversal_requests"},"charge_all_transfer_requests":{"$ref":"#/components/schemas/charge_all_transfer_requests"},"charge_dues_assessments":{"$ref":"#/components/schemas/charge_dues_assessments"},"charge_interchange":{"$ref":"#/components/schemas/charge_interchange"},"compliance_forms_overdue_fixed_fee":{"$ref":"#/components/schemas/compliance_forms_overdue_fixed_fee"},"diners_club_basis_points":{"$ref":"#/components/schemas/diners_club_basis_points"},"diners_club_charge_interchange":{"$ref":"#/components/schemas/diners_club_charge_interchange"},"diners_club_fixed_fee":{"$ref":"#/components/schemas/diners_club_fixed_fee"},"discover_assessments_basis_points":{"$ref":"#/components/schemas/discover_assessments_basis_points"},"discover_basis_points":{"$ref":"#/components/schemas/discover_basis_points"},"discover_charge_dues_assessments":{"$ref":"#/components/schemas/discover_charge_dues_assessments"},"discover_charge_interchange":{"$ref":"#/components/schemas/discover_charge_interchange"},"discover_data_usage_fixed_fee":{"$ref":"#/components/schemas/discover_data_usage_fixed_fee"},"discover_externally_funded_basis_points":{"$ref":"#/components/schemas/discover_externally_funded_basis_points"},"discover_externally_funded_fixed_fee":{"$ref":"#/components/schemas/discover_externally_funded_fixed_fee"},"discover_fixed_fee":{"$ref":"#/components/schemas/discover_fixed_fee"},"discover_network_authorization_fixed_fee":{"$ref":"#/components/schemas/discover_network_authorization_fixed_fee"},"dispute_fixed_fee":{"$ref":"#/components/schemas/dispute_fixed_fee"},"dispute_inquiry_fixed_fee":{"$ref":"#/components/schemas/dispute_inquiry_fixed_fee"},"eft_basis_points":{"$ref":"#/components/schemas/eft_basis_points"},"eft_basis_points_fee_limit":{"$ref":"#/components/schemas/eft_basis_points_fee_limit"},"eft_credit_return_fixed_fee":{"$ref":"#/components/schemas/eft_credit_return_fixed_fee"},"eft_debit_return_fixed_fee":{"$ref":"#/components/schemas/eft_debit_return_fixed_fee"},"eft_fixed_fee":{"$ref":"#/components/schemas/eft_fixed_fee"},"eft_validation_plaid_fixed_fee":{"$ref":"#/components/schemas/eft_validation_plaid_fixed_fee"},"externally_funded_basis_points":{"$ref":"#/components/schemas/externally_funded_basis_points"},"externally_funded_fixed_fee":{"$ref":"#/components/schemas/externally_funded_fixed_fee"},"fixed_fee":{"$ref":"#/components/schemas/fixed_fee"},"gross_monthly_fees_ach_basis_points":{"$ref":"#/components/schemas/gross_monthly_fees_ach_basis_points"},"gross_monthly_fees_ach_fixed_fee":{"$ref":"#/components/schemas/gross_monthly_fees_ach_fixed_fee"},"gross_monthly_fees_card_basis_points":{"$ref":"#/components/schemas/gross_monthly_fees_card_basis_points"},"gross_monthly_fees_card_fixed_fee":{"$ref":"#/components/schemas/gross_monthly_fees_card_fixed_fee"},"gross_monthly_fees_eft_basis_points":{"$ref":"#/components/schemas/gross_monthly_fees_eft_basis_points"},"gross_monthly_fees_eft_fixed_fee":{"$ref":"#/components/schemas/gross_monthly_fees_eft_fixed_fee"},"interac_basis_points":{"$ref":"#/components/schemas/interac_basis_points"},"interac_fixed_fee":{"$ref":"#/components/schemas/interac_fixed_fee"},"jcb_basis_points":{"$ref":"#/components/schemas/jcb_basis_points"},"jcb_charge_interchange":{"$ref":"#/components/schemas/jcb_charge_interchange"},"jcb_fixed_fee":{"$ref":"#/components/schemas/jcb_fixed_fee"},"mastercard_acquirer_fees_basis_points":{"$ref":"#/components/schemas/mastercard_acquirer_fees_basis_points"},"mastercard_assessments_over1k_basis_points":{"$ref":"#/components/schemas/mastercard_assessments_over1k_basis_points"},"mastercard_assessments_under1k_basis_points":{"$ref":"#/components/schemas/mastercard_assessments_under1k_basis_points"},"mastercard_basis_points":{"$ref":"#/components/schemas/mastercard_basis_points"},"mastercard_charge_dues_assessments":{"$ref":"#/components/schemas/mastercard_charge_dues_assessments"},"mastercard_charge_interchange":{"$ref":"#/components/schemas/mastercard_charge_interchange"},"mastercard_fixed_fee":{"$ref":"#/components/schemas/mastercard_fixed_fee"},"payment_instrument_tokenization_fixed_fee":{"$ref":"#/components/schemas/payment_instrument_tokenization_fixed_fee"},"recurring_monthly_fixed_cycle_day":{"$ref":"#/components/schemas/recurring_monthly_fixed_cycle_day"},"recurring_monthly_fixed_fee":{"$ref":"#/components/schemas/recurring_monthly_fixed_fee"},"recurring_yearly_fixed_cycle_day":{"$ref":"#/components/schemas/recurring_yearly_fixed_cycle_day"},"recurring_yearly_fixed_cycle_month":{"$ref":"#/components/schemas/recurring_yearly_fixed_cycle_month"},"recurring_yearly_fixed_fee":{"$ref":"#/components/schemas/recurring_yearly_fixed_fee"},"settlement_funding_transfer_ach_basis_points":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_basis_points"},"settlement_funding_transfer_ach_basis_points_fee_limit":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_basis_points_fee_limit"},"settlement_funding_transfer_ach_credit_return_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_credit_return_fixed_fee"},"settlement_funding_transfer_ach_debit_return_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_debit_return_fixed_fee"},"settlement_funding_transfer_ach_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_ach_fixed_fee"},"settlement_funding_transfer_eft_basis_points":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_basis_points"},"settlement_funding_transfer_eft_basis_points_fee_limit":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_basis_points_fee_limit"},"settlement_funding_transfer_eft_credit_return_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_credit_return_fixed_fee"},"settlement_funding_transfer_eft_debit_return_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_debit_return_fixed_fee"},"settlement_funding_transfer_eft_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_eft_fixed_fee"},"settlement_funding_transfer_instant_payout_card_basis_points":{"$ref":"#/components/schemas/settlement_funding_transfer_instant_payout_card_basis_points"},"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":{"$ref":"#/components/schemas/settlement_funding_transfer_instant_payout_card_basis_points_fee_limit"},"settlement_funding_transfer_instant_payout_card_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_instant_payout_card_fixed_fee"},"settlement_funding_transfer_noc_credit_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_noc_credit_fixed_fee"},"settlement_funding_transfer_noc_debit_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_noc_debit_fixed_fee"},"settlement_funding_transfer_same_day_ach_basis_points":{"$ref":"#/components/schemas/settlement_funding_transfer_same_day_ach_basis_points"},"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":{"$ref":"#/components/schemas/settlement_funding_transfer_same_day_ach_basis_points_fee_limit"},"settlement_funding_transfer_same_day_ach_fixed_fee":{"$ref":"#/components/schemas/settlement_funding_transfer_same_day_ach_fixed_fee"},"subscription_ach_basis_points":{"$ref":"#/components/schemas/subscription_ach_basis_points"},"subscription_ach_basis_points_fee_limit":{"$ref":"#/components/schemas/subscription_ach_basis_points_fee_limit"},"subscription_ach_fixed_fee":{"$ref":"#/components/schemas/subscription_ach_fixed_fee"},"subscription_card_basis_points":{"$ref":"#/components/schemas/subscription_card_basis_points"},"subscription_card_fixed_fee":{"$ref":"#/components/schemas/subscription_card_fixed_fee"},"subscription_eft_basis_points":{"$ref":"#/components/schemas/subscription_eft_basis_points"},"subscription_eft_basis_points_fee_limit":{"$ref":"#/components/schemas/subscription_eft_basis_points_fee_limit"},"subscription_eft_fixed_fee":{"$ref":"#/components/schemas/subscription_eft_fixed_fee"},"tap_to_pay_basis_points":{"$ref":"#/components/schemas/tap_to_pay_basis_points"},"tap_to_pay_fixed_fee":{"$ref":"#/components/schemas/tap_to_pay_fixed_fee"},"third_party_gateway_cybersource_basis_points":{"$ref":"#/components/schemas/third_party_gateway_cybersource_basis_points"},"third_party_gateway_cybersource_fixed_fee":{"$ref":"#/components/schemas/third_party_gateway_cybersource_fixed_fee"},"visa_acquirer_processing_fixed_fee":{"$ref":"#/components/schemas/visa_acquirer_processing_fixed_fee"},"visa_assessments_basis_points":{"$ref":"#/components/schemas/visa_assessments_basis_points"},"visa_basis_points":{"$ref":"#/components/schemas/visa_basis_points"},"visa_charge_dues_assessments":{"$ref":"#/components/schemas/visa_charge_dues_assessments"},"visa_charge_interchange":{"$ref":"#/components/schemas/visa_charge_interchange"},"visa_credit_voucher_fixed_fee":{"$ref":"#/components/schemas/visa_credit_voucher_fixed_fee"},"visa_fixed_fee":{"$ref":"#/components/schemas/visa_fixed_fee"},"visa_kilobyte_access_fixed_fee":{"$ref":"#/components/schemas/visa_kilobyte_access_fixed_fee"}}}},"components/schemas/createFeeProfileNoFees":{"id":"components/schemas/createFeeProfileNoFees","kind":"json-schema","title":"No Fees","data":{"type":"object","title":"No Fees","properties":{"ach_basis_points":{"$ref":"#/components/schemas/ach_basis_points"},"ach_credit_return_fixed_fee":{"$ref":"#/components/schemas/ach_credit_return_fixed_fee"},"ach_debit_return_fixed_fee":{"$ref":"#/components/schemas/ach_debit_return_fixed_fee"},"ach_fixed_fee":{"$ref":"#/components/schemas/ach_fixed_fee"},"basis_points":{"$ref":"#/components/schemas/basis_points"},"dispute_fixed_fee":{"$ref":"#/components/schemas/dispute_fixed_fee"},"fixed_fee":{"$ref":"#/components/schemas/fixed_fee"}}}},"components/schemas/fee":{"id":"components/schemas/fee","kind":"json-schema","title":"fee","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A charge levied against a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"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":"Represents the total amount. The value may be returned as 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":"an "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"int32"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") in cents (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = $1.00), or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"double"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for fractional amounts (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2.393"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"example":2.393},"application":{"$ref":"#/components/schemas/application_id"},"category":{"type":"string","description":[{"$$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":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" category."},"children":[]}]}]}],"enum":["PROCESSOR","INTERCHANGE","DUES_AND_ASSESSMENTS","THIRD_PARTY_SERVICE_PROVIDER"],"nullable":true},"currency":{"$ref":"#/components/schemas/currency"},"display_name":{"type":"string","description":"It is used for subscription fees and allows free-form text to be passed from the subscription fee product. Note that this product is mostly deprecated.","nullable":true},"fee_profile":{"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":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to calculate fees for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" related to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"fee_subtype":{"type":"string","enum":["CUSTOM","APPLICATION_FEE","PLATFORM_FEE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subtype of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fee_type":{"type":"string","enum":["ACH_BASIS_POINTS","ACH_CREDIT_RETURN_FIXED_FEE","ACH_DEBIT_RETURN_FIXED_FEE","ACH_FIXED","ACH_MAX_FIXED","ACH_NOTICE_OF_CHANGE_CREDIT_FIXED","ACH_NOTICE_OF_CHANGE_DEBIT_FIXED","ACH_VALIDATION_PLAID_FIXED","AFTERPAY_BASIS_POINTS","AFTERPAY_FIXED","AMERICAN_EXPRESS_BASIS_POINTS","AMERICAN_EXPRESS_EXTERNALLY_FUNDED_BASIS_POINTS","AMERICAN_EXPRESS_EXTERNALLY_FUNDED_FIXED","AMERICAN_EXPRESS_FIXED","AMERICAN_EXPRESS_INTERCHANGE","ANCILLARY_FIXED_FEE_PRIMARY","ANCILLARY_FIXED_FEE_SECONDARY","APPLICATION_FEE","CARD_ACCOUNT_UPDATER_FIXED","CARD_BASIS_POINTS","CARD_CROSS_BORDER_BASIS_POINTS","CARD_CROSS_BORDER_FIXED_FEE","CARD_EXTERNALLY_FUNDED_BASIS_POINTS","CARD_EXTERNALLY_FUNDED_FIXED","CARD_FIXED","CARD_INTERCHANGE","CUSTOM","CARD_NAME_VERIFICATION_FIXED","CARD_NETWORK_TOKEN_FIXED","CASH_APP_PAY_BASIS_POINTS","CASH_APP_PAY_FIXED","COMPLIANCE_FORM_OVERDUE_FIXED","DINERS_CLUB_BASIS_POINTS","DINERS_CLUB_FIXED","DINERS_CLUB_INTERCHANGE","DISCOVER_BASIS_POINTS","DISCOVER_DATA_USAGE_FIXED","DISCOVER_EXTERNALLY_FUNDED_BASIS_POINTS","DISCOVER_EXTERNALLY_FUNDED_FIXED","DISCOVER_FIXED","DISCOVER_INTERCHANGE","DISCOVER_NETWORK_AUTHORIZATION_FIXED","DISPUTE_FIXED_FEE","DISPUTE_INQUIRY_FIXED_FEE","EFT_BASIS_POINTS","EFT_CREDIT_RETURN_FIXED_FEE","EFT_DEBIT_RETURN_FIXED_FEE","EFT_FIXED","EFT_MAX_FIXED","EFT_VALIDATION_PLAID_FIXED","GROSS_MONTHLY_FEES_ACH_BASIS_POINTS","GROSS_MONTHLY_FEES_ACH_FIXED","GROSS_MONTHLY_FEES_CARD_BASIS_POINTS","GROSS_MONTHLY_FEES_CARD_FIXED","GROSS_MONTHLY_FEES_EFT_BASIS_POINTS","GROSS_MONTHLY_FEES_EFT_FIXED","INTERAC_BASIS_POINTS","INTERAC_FIXED","INVOICE_ACH_BASIS_POINTS","INVOICE_ACH_FIXED","INVOICE_ACH_MAX_FIXED","INVOICE_CARD_BASIS_POINTS","INVOICE_CARD_FIXED","INVOICE_EFT_BASIS_POINTS","INVOICE_EFT_FIXED","INVOICE_EFT_MAX_FIXED","JCB_BASIS_POINTS","JCB_FIXED","JCB_INTERCHANGE","MASTERCARD_ACQUIRER_FEE_BASIS_POINTS","MASTERCARD_BASIS_POINTS","MASTERCARD_FIXED","MASTERCARD_INTERCHANGE","QUALIFIED_TIER_BASIS_POINTS_FEE","QUALIFIED_TIER_FIXED_FEE","PAYMENT_INSTRUMENT_TOKENIZATION_FIXED","SETTLEMENT_FUNDING_TRANSFER_ACH_BASIS_POINTS","SETTLEMENT_FUNDING_TRANSFER_ACH_CREDIT_RETURN_FIXED","SETTLEMENT_FUNDING_TRANSFER_ACH_DEBIT_RETURN_FIXED","SETTLEMENT_FUNDING_TRANSFER_ACH_FIXED","SETTLEMENT_FUNDING_TRANSFER_ACH_MAX_FIXED","SETTLEMENT_FUNDING_TRANSFER_EFT_BASIS_POINTS","SETTLEMENT_FUNDING_TRANSFER_EFT_CREDIT_RETURN_FIXED","SETTLEMENT_FUNDING_TRANSFER_EFT_DEBIT_RETURN_FIXED","SETTLEMENT_FUNDING_TRANSFER_EFT_FIXED","SETTLEMENT_FUNDING_TRANSFER_EFT_MAX_FIXED","SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_BASIS_POINTS","SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_FIXED","SETTLEMENT_FUNDING_TRANSFER_INSTANT_PAYOUT_CARD_MAX_FIXED","SETTLEMENT_FUNDING_TRANSFER_NOC_CREDIT_FIXED","SETTLEMENT_FUNDING_TRANSFER_NOC_DEBIT_FIXED","SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_BASIS_POINTS","SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_FIXED","SETTLEMENT_FUNDING_TRANSFER_SAME_DAY_ACH_MAX_FIXED","SUBSCRIPTION_ACH_BASIS_POINTS","SUBSCRIPTION_ACH_FIXED","SUBSCRIPTION_ACH_MAX_FIXED","SUBSCRIPTION_CARD_BASIS_POINTS","SUBSCRIPTION_CARD_FIXED","SUBSCRIPTION_EFT_BASIS_POINTS","SUBSCRIPTION_EFT_FIXED","SUBSCRIPTION_EFT_MAX_FIXED","SUPPLEMENTAL_FEE_FIXED","THIRD_PARTY_GATEWAY_CYBERSOURCE_BASIS_POINTS","THIRD_PARTY_GATEWAY_CYBERSOURCE_FIXED","VISA_ACQUIRER_PROCESSING_FIXED","VISA_BASE_II_CREDIT_VOUCHER_FIXED","VISA_BASE_II_SYSTEM_FILE_TRANSMISSION_FIXED","VISA_BASIS_POINTS","VISA_COMMERCIAL_ENHANCED_DATA_PROGRAM_BASIS_POINTS","VISA_CREDIT_VOUCHER_FIXED","VISA_FIXED","VISA_INTERCHANGE","VISA_KILOBYTE_ACCESS_FIXED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Finix may return more enums than those provided. Ensure your code accepts additional enums returned by Finix."},"children":[]}]}]}]},"label":{"type":"string","description":"It is used for subscription fees and allows free-form text to be passed from the subscription fee product. Note that this product is mostly deprecated.","nullable":true},"linked_id":{"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":"The ID of the linked resource. Note that this field will be deprecated soon, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},"linked_to":{"type":"string","nullable":true,"description":"The ID of the linked resource."},"linked_type":{"type":"string","nullable":true,"enum":["TRANSFER","AUTHORIZATION","SPLIT_TRANSFER"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of entity the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked to."},"children":[]}]}]}]},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that was charged the fee."},"children":[]}]}]}]},"ready_to_settle_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp indicating when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" related to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ready to be settled. The specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is identified by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"nullable":true},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"self":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"merchant":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the fee was debited from."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"transfer":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that generated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}}}}}},"components/schemas/createCustomFee":{"id":"components/schemas/createCustomFee","kind":"json-schema","title":"createCustomFee","data":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"display_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The display name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that can be used for filtering purposes."},"children":[]}]}]}]},"fee_subtype":{"type":"string","enum":["CUSTOM"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subtype of the fee. Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CUSTOM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fee_type":{"type":"string","enum":["CUSTOM"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the fee. Must be set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CUSTOM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","fee_subtype","fee_type","merchant"]}},"components/schemas/updateFee":{"id":"components/schemas/updateFee","kind":"json-schema","title":"updateFee","data":{"type":"object","properties":{"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/GatewayIntegration":{"id":"components/schemas/GatewayIntegration","kind":"json-schema","title":"Gateway Integration object","data":{"title":"Gateway Integration object","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application_id":{"$ref":"#/components/schemas/application_id"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked."},"children":[]}]}]}],"example":"MUeg77opgdgQpwejzC9wCNm"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of resource to which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked."},"children":[]}]}]}],"enum":["MERCHANT"]},"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address to receive the Cybersource dashboard invitation, which lets you retrieve your Cybersource transacting credentials. If this field was not provided, the invitation will be sent to the email address associated with the merchant's email address defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" › "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity.email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"format":"email","example":"johndoe@acme.com"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The possible values are:"},"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":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is being processed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was successful."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" failed."},"children":[]}]}]}]}],"enum":["FAILED","PENDING","SUCCEEDED"]},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". At this time, the only supported value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CYBERSOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["CYBERSOURCE"]},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"}}}}}},"components/schemas/createGatewayIntegration":{"id":"components/schemas/createGatewayIntegration","kind":"json-schema","title":"Gateway Integration","data":{"title":"Gateway Integration","type":"object","properties":{"email":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The email address to receive the Cybersource dashboard invitation, which lets you retrieve your Cybersource transacting credentials. If this field is not provided, the invitation will be sent to the email address associated with the merchant's email address defined in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" › "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity.email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"format":"email","example":"johndoe@acme.com"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked to."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to create. At this time, the only supported value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CYBERSOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["CYBERSOURCE"]}},"required":["type"]}},"components/schemas/additional_underwriting_data":{"id":"components/schemas/additional_underwriting_data","kind":"json-schema","title":"additional_underwriting_data","data":{"type":"object","description":"Additional underwriting data about the seller.","properties":{"annual_ach_volume":{"type":"integer","description":"The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters)."},"annual_card_volume":{"type":"integer","description":"The approximate annual credit card sales expected to be processed (in cents) by this merchant."},"average_ach_transfer_amount":{"type":"integer","description":"The approximate average ACH sale amount (in cents) for this merchant."},"average_card_transfer_amount":{"type":"integer","description":"The average credit card sale amount (in cents) for this merchant."},"business_description":{"type":"string","minLength":1,"description":"Description of this merchant's business (max 200 characters)."},"card_volume_distribution":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The distribution of the merchant's credit card volume The sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_volume_distribution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be 100."},"children":[]}]}]}],"nullable":true,"properties":{"card_present_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's card present (between 0 and 100)."},"ecommerce_percentage":{"type":"integer","description":"The percentage of the merchant's business that is eCommerce (between 0 and 100)."},"mail_order_telephone_order_percentage":{"type":"integer","description":"The percentage of the merchant's business that is a mail or telephone order (between 0 and 100)."}}},"credit_check_allowed":{"type":"boolean","description":"Sets if this merchant has consented and accepted to a credit check."},"credit_check_ip_address":{"type":"string","minLength":1,"description":"The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.112 )."},"credit_check_timestamp":{"type":"string","minLength":1,"description":"A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z)."},"credit_check_user_agent":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6))."},"children":[]}]}]}]},"merchant_agreement_accepted":{"type":"boolean","description":"Sets whether this merchant has accepted the terms and conditions of the merchant agreement. Required for USA and CAN sellers."},"merchant_agreement_ip_address":{"type":"string","minLength":1,"description":"IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113). Required for USA and CAN sellers."},"merchant_agreement_timestamp":{"type":"string","minLength":1,"description":"Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z). Required for USA and CAN sellers."},"merchant_agreement_user_agent":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)). Required for USA and CAN sellers."},"children":[]}]}]}]},"refund_policy":{"type":"string","minLength":1,"description":"Include the value that best applies to the merchant's refund policy.","enum":["NO_REFUNDS","MERCHANDISE_EXCHANGE_ONLY","WITHIN_30_DAYS","OTHER"]},"volume_distribution_by_business_type":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant's distribution of credit card volume by business type. Sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume_distribution_by_business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be 100."},"children":[]}]}]}],"nullable":true,"properties":{"business_to_business_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's business to business (between 0 and 100)."},"business_to_consumer_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's business to consumer (between 0 and 100)."},"consumer_to_consumer_volume_percentage":{"type":"integer","description":"Merchant's percentage of volume that is consumer to consumer (between 0 and 100)."},"other_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that isn't represented by the previous fields (between 0 and 100)."},"person_to_person_volume_percentage":{"type":"integer","description":"The percentage the merchant's volume that's person to person (between 0 and 100)."}}}}}},"components/schemas/entity":{"id":"components/schemas/entity","kind":"json-schema","title":"entity","data":{"type":"object","properties":{"amex_mid":{"type":"integer","description":"Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.","nullable":true},"annual_card_volume":{"type":"integer","description":"The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters).","nullable":true},"business_address":{"type":"object","description":"The primary address for the legal entity.","nullable":true,"properties":{"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters).","nullable":true},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"city":{"type":"string","minLength":1,"description":"City (max 20 characters).","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters).","nullable":true},"country":{"type":"string","minLength":1,"description":"3-Letter Country code (e.g. USA).","nullable":true}}},"business_name":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's legal business name (max 120 characters)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass the owner's legal first name, last name, and middle initial."},"children":[]}]}]}]}]}],"nullable":true},"business_phone":{"type":"string","minLength":1,"description":"Customer service phone number where the merchant can be reached (max 10 characters).","nullable":true},"business_tax_id":{"type":"string","description":[{"$$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":"US-based Merchants"},"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":"Nine-digit Tax Identification Number (TIN) or Employer Identification Number (EIN). If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and they do not have an EIN, use the sole proprietor's Social Security Number (SSN)."},"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":"Canada-based Merchants"},"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":"Nine-digit Business Number (BN) issued by the Canada Revenue Agency (CRA) for business tax purposes. If the business_type is INDIVIDUAL_SOLE_PROPRIETORSHIP and they do not have a Business Number, use the sole proprietor’s Social Insurance Number (SIN)."},"children":[]}]}]}]},"business_tax_id_fingerprint":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique fingerprint for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_tax_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"business_tax_id_provided":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_tax_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been provided."},"children":[]}]}]}]},"business_type":{"description":"Include the value that best applies to the merchant.","type":"string","enum":["INDIVIDUAL_SOLE_PROPRIETORSHIP","CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","ASSOCIATION_ESTATE_TRUST","TAX_EXEMPT_ORGANIZATION","GOVERNMENT_AGENCY"],"nullable":true},"default_statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"discover_mid":{"description":"Assigned discoverMid value.","type":"integer","nullable":true},"dob":{"type":"object","description":"The control owner's date of birth.","nullable":true,"properties":{"day":{"type":"integer","description":"Day of birth (between 1 and 31).","minimum":1},"month":{"type":"integer","description":"Month of birth (between 1 and 12).","minimum":1},"year":{"type":"integer","description":"Year of birth (4-digit). Year must be greater than 1900.","minimum":1900}}},"doing_business_as":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (max 60 characters)."},"children":[]}]}]}],"nullable":true},"email":{"type":"string","minLength":1,"description":"The email address of the entity or its control owner (max 100 characters).","nullable":true},"first_name":{"type":"string","minLength":1,"description":"The legal first name of the entity or its control owner (max 20 characters).","nullable":true},"has_accepted_credit_cards_previously":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not passed."},"children":[]}]}]}]},"incorporation_date":{"type":"object","description":"The date the company was founded and registered.","nullable":true,"properties":{"day":{"type":"integer","description":"Day business was incorporated (between 1 and 31)."},"month":{"type":"integer","description":"Month business was incorporated (between 1 and 12)."},"year":{"type":"integer","description":"Year business was incorporated (4-digit)."}}},"last_name":{"type":"string","minLength":1,"description":"The legal last name of the entity or its control owner (max 20 characters).","nullable":true},"max_transaction_amount":{"type":"integer","description":"The maximum amount (in cents) that can be charged for a single transaction (max 12 characters).","nullable":true},"ach_max_transaction_amount":{"type":"integer","description":"The maximum amount (in cents) that can be processed for a single ACH transaction (max 12 characters).","nullable":true},"mcc":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant Category Code ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that this merchant will be classified under. For a list of approved MCCs, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/approved-merchant-category-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved Merchant Category Codes."},"children":[]}]}]}]}],"nullable":true},"ownership_type":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values can be either: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUBLIC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate a publicly-traded company."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIVATE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for privately-held businesses."},"children":[]}]}]}]}]}],"enum":["PUBLIC","PRIVATE"],"nullable":true},"personal_address":{"type":"object","nullable":true,"description":"The personal address of the entity or its control owner.","properties":{"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters).","nullable":true},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"city":{"type":"string","minLength":1,"description":"City (max 20 characters).","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter State code.","nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters).","nullable":true},"country":{"$ref":"#/components/schemas/country"}},"required":["city","country","line1","postal_code","region"]},"phone":{"type":"string","minLength":1,"description":"The phone number of the entity or its control owner (max 10 characters).","nullable":true},"principal_percentage_ownership":{"type":"integer","description":"Percentage of the company owned by the principal control owner (min 0; max 100).","nullable":true},"short_business_name":{"type":"string","description":"Abbreviated names of the business. If there are no abbreviated name, leave this field blank.","nullable":true},"tax_authority":{"type":"string","description":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only required when onboarding a merchant with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"9311"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"tax_authority"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is the tax gathering entity (e.g., San Francisco Water Authority)."},"children":[]}]}]}],"nullable":true},"tax_id":{"type":"string","description":"The control owner's Social Security Number (SSN) or an Individual Taxpayer Identification Number (ITIN). This is required for identity verification. It is not included in the response.","nullable":true},"tax_id_fingerprint":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique fingerprint for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"tax_id_provided":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has been provided."},"children":[]}]}]}]},"title":{"type":"string","minLength":1,"description":"The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).","nullable":true},"url":{"type":"string","minLength":1,"description":"The URL of the merchant's public website.","nullable":true}}}},"components/schemas/identity_roles":{"id":"components/schemas/identity_roles","kind":"json-schema","title":"identity_roles","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of roles available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If none is provided, the Identity will be assigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUYER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["APPLICATION_OWNER","BENEFICIAL_OWNER","BUYER","PLATFORM_OWNER","RECIPIENT","SELLER","SENDER"]}}},"components/schemas/verifications":{"id":"components/schemas/verifications","kind":"json-schema","title":"verifications","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/merchants":{"id":"components/schemas/merchants","kind":"json-schema","title":"merchants","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/settlements":{"id":"components/schemas/settlements","kind":"json-schema","title":"settlements","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/authorizations":{"id":"components/schemas/authorizations","kind":"json-schema","title":"authorizations","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/payment_instruments":{"id":"components/schemas/payment_instruments","kind":"json-schema","title":"payment_instruments","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrume"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/associated_identities":{"id":"components/schemas/associated_identities","kind":"json-schema","title":"associated_identities","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to any other "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identites"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the request."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/disputes":{"id":"components/schemas/disputes","kind":"json-schema","title":"disputes","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}},"components/schemas/identity":{"id":"components/schemas/identity","kind":"json-schema","title":"Identity","data":{"title":"Identity","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"additional_underwriting_data":{"$ref":"#/components/schemas/additional_underwriting_data"},"application":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the resource."},"children":[]}]}]}]},"entity":{"$ref":"#/components/schemas/entity"},"identity_roles":{"$ref":"#/components/schemas/identity_roles"},"type":{"type":"string","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"enum":["PERSONAL","BUSINESS"]},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"verifications":{"$ref":"#/components/schemas/verifications"},"merchants":{"$ref":"#/components/schemas/merchants"},"settlements":{"$ref":"#/components/schemas/settlements"},"authorizations":{"$ref":"#/components/schemas/authorizations"},"transfers":{"$ref":"#/components/schemas/transfers"},"payment_instruments":{"$ref":"#/components/schemas/payment_instruments"},"associated_identities":{"$ref":"#/components/schemas/associated_identities"},"disputes":{"$ref":"#/components/schemas/disputes"},"application":{"$ref":"#/components/schemas/application_link"}}}}}},"components/schemas/createIdentitySellerUSA":{"id":"components/schemas/createIdentitySellerUSA","kind":"json-schema","title":"Seller (USA)","data":{"title":"Seller (USA)","type":"object","properties":{"additional_underwriting_data":{"type":"object","description":"Additional underwriting data about the user.","properties":{"annual_ach_volume":{"type":"integer","description":"The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters)."},"average_ach_transfer_amount":{"type":"integer","description":"The approximate average ACH sale amount (in cents) for this merchant."},"average_card_transfer_amount":{"type":"integer","description":"The average credit card sale amount (in cents) for this merchant."},"business_description":{"type":"string","minLength":1,"description":"Description of this merchant's business (max 200 characters)."},"card_volume_distribution":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The distribution of the merchant's credit card volume The sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_volume_distribution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be 100."},"children":[]}]}]}],"nullable":true,"properties":{"card_present_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's card present (between 0 and 100)."},"ecommerce_percentage":{"type":"integer","description":"The percentage of the merchant's business that is eCommerce (between 0 and 100)."},"mail_order_telephone_order_percentage":{"type":"integer","description":"The percentage of the merchant's business that is a mail or telephone order (between 0 and 100)."}}},"credit_check_allowed":{"type":"boolean","description":"Sets if this merchant has consented and accepted to a credit check."},"credit_check_ip_address":{"type":"string","minLength":1,"description":"The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.112 )."},"credit_check_timestamp":{"type":"string","minLength":1,"description":"A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z)."},"credit_check_user_agent":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6))."},"children":[]}]}]}]},"merchant_agreement_accepted":{"type":"boolean","description":"Sets whether this merchant has accepted the terms and conditions of the merchant agreement. Required."},"merchant_agreement_ip_address":{"type":"string","minLength":1,"description":"IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113). Required."},"merchant_agreement_timestamp":{"type":"string","minLength":1,"description":"Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z). Required."},"merchant_agreement_user_agent":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)). Required."},"children":[]}]}]}]},"refund_policy":{"type":"string","minLength":1,"description":"Include the value that best applies to the merchant's refund policy.","enum":["MERCHANDISE_EXCHANGE_ONLY","NO_REFUNDS","OTHER","WITHIN_30_DAYS"]},"volume_distribution_by_business_type":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant's distribution of credit card volume by business type. Sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume_distribution_by_business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be 100."},"children":[]}]}]}],"nullable":true,"properties":{"business_to_business_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's business to business (between 0 and 100)."},"business_to_consumer_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's business to consumer (between 0 and 100)."},"consumer_to_consumer_volume_percentage":{"type":"integer","description":"Merchant's percentage of volume that is consumer to consumer (between 0 and 100)."},"other_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that isn't represented by the previous fields (between 0 and 100)."},"person_to_person_volume_percentage":{"type":"integer","description":"The percentage the merchant's volume that's person to person (between 0 and 100)."}}}},"required":["annual_ach_volume","average_ach_transfer_amount","average_card_transfer_amount","business_description","card_volume_distribution","merchant_agreement_accepted","merchant_agreement_ip_address","merchant_agreement_timestamp","merchant_agreement_user_agent","refund_policy","volume_distribution_by_business_type"]},"entity":{"type":"object","properties":{"ach_max_transaction_amount":{"type":"integer","description":"The maximum amount (in cents) that can be processed for a single ACH transaction (max 12 characters)."},"amex_mid":{"type":"integer","description":"Assigned amexMid value. If a value is passed, it must be 10 or 11 digits."},"annual_card_volume":{"type":"integer","description":"The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters)."},"business_address":{"type":"object","description":"The primary address for the legal entity.","properties":{"city":{"type":"string","minLength":1,"description":"City (max 20 characters)."},"country":{"type":"string","minLength":1,"description":"3-Letter Country code (e.g. USA)."},"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters)."},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters)."},"postal_code":{"type":"string","minLength":1,"description":"Zip code (max 7 characters)."},"region":{"type":"string","minLength":1,"description":"2-letter state code."}}},"business_name":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's legal business name (max 120 characters)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass the owner's legal first name, last name, and middle initial."},"children":[]}]}]}]}]}]},"business_phone":{"type":"string","minLength":1,"description":"Customer service phone number where the merchant can be reached (max 10 characters)."},"business_tax_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and they do not have an EIN, use the sole proprietor's Social Security Number (SSN)."},"children":[]}]}]}]},"business_type":{"description":"Include the value that best applies to the merchant.","type":"string","enum":["ASSOCIATION_ESTATE_TRUST","CORPORATION","GENERAL_PARTNERSHIP","GOVERNMENT_AGENCY","INDIVIDUAL_SOLE_PROPRIETORSHIP","LIMITED_LIABILITY_COMPANY","LIMITED_PARTNERSHIP","PARTNERSHIP","TAX_EXEMPT_ORGANIZATION"]},"default_statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"discover_mid":{"description":"Assigned discoverMid value.","type":"integer"},"dob":{"type":"object","description":"The control owner's date of birth.","properties":{"day":{"type":"integer","description":"Day of birth (between 1 and 31).","minimum":1},"month":{"type":"integer","description":"Month of birth (between 1 and 12).","minimum":1},"year":{"type":"integer","description":"Year of birth (4-digit). Year must be greater than 1900.","minimum":1900}}},"doing_business_as":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (max 60 characters)."},"children":[]}]}]}]},"email":{"type":"string","minLength":1,"description":"The email address of the principal control owner where they can be reached (max 100 characters)."},"first_name":{"type":"string","minLength":1,"description":"The legal first name of the merchant's control owner (max 20 characters)."},"has_accepted_credit_cards_previously":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not passed."},"children":[]}]}]}]},"incorporation_date":{"type":"object","description":"The date the company was founded and registered.","properties":{"day":{"type":"integer","description":"Day business was incorporated (between 1 and 31)."},"month":{"type":"integer","description":"Month business was incorporated (between 1 and 12)."},"year":{"type":"integer","description":"Year business was incorporated (4-digit)."}}},"last_name":{"type":"string","minLength":1,"description":"The legal last name of the merchant's control owner (max 20 characters)."},"max_transaction_amount":{"type":"integer","description":"The maximum amount (in cents) that can be charged for a single transaction (max 12 characters)."},"mcc":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant Category Code ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that this merchant will be classified under. For a list of approved MCCs, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/approved-merchant-category-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved Merchant Category Codes."},"children":[]}]}]}]}]},"ownership_type":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values can be either: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUBLIC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate a publicly-traded company."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIVATE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for privately-held businesses."},"children":[]}]}]}]}]}],"enum":["PRIVATE","PUBLIC"]},"personal_address":{"allOf":[{"$ref":"#/components/schemas/address"}],"description":"The entity's personal address."},"phone":{"type":"string","minLength":1,"description":"The principal control owner's phone number (max 10 characters)."},"principal_percentage_ownership":{"type":"integer","description":"Percentage of the company owned by the principal control owner (min 0; max 100)."},"short_business_name":{"type":"string","description":"Abbreviated names of the business. If there are no abbreviated name, leave this field blank."},"tax_authority":{"type":"string","description":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only required when onboarding a merchant with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"9311"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"tax_authority"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is the tax gathering entity (e.g., San Francisco Water Authority)."},"children":[]}]}]}]},"tax_id":{"type":"string","description":"The control owner's Social Security Number (SSN) or Individual Taxpayer Identification Number (ITIN). Required for identity verification. Not included in the response."},"title":{"type":"string","minLength":1,"description":"The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters)."},"url":{"type":"string","minLength":1,"description":"The URL of the merchant's public website."}}},"identity_roles":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of roles available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["SELLER"]}},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":"The identity type.","enum":["BUSINESS"]}},"required":["additional_underwriting_data"]}},"components/schemas/createIdentitySellerCAN":{"id":"components/schemas/createIdentitySellerCAN","kind":"json-schema","title":"Seller (CAN)","data":{"title":"Seller (CAN)","type":"object","properties":{"additional_underwriting_data":{"type":"object","description":"Additional underwriting data about the user.","properties":{"average_card_transfer_amount":{"type":"integer","description":"The average credit card sale amount (in cents) for this merchant."},"business_description":{"type":"string","minLength":1,"description":"Description of this merchant's business (max 200 characters)."},"card_volume_distribution":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The distribution of the merchant's credit card volume The sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_volume_distribution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be 100."},"children":[]}]}]}],"properties":{"card_present_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's card present (between 0 and 100)."},"ecommerce_percentage":{"type":"integer","description":"The percentage of the merchant's business that is eCommerce (between 0 and 100)."},"mail_order_telephone_order_percentage":{"type":"integer","description":"The percentage of the merchant's business that is a mail or telephone order (between 0 and 100)."}}},"credit_check_allowed":{"type":"boolean","description":"Sets if this merchant has consented and accepted to a credit check."},"credit_check_ip_address":{"type":"string","minLength":1,"description":"The IP address of the merchant when they consented to a credit check (e.g., 42.1.1.112 )."},"credit_check_timestamp":{"type":"string","minLength":1,"description":"A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z)."},"credit_check_user_agent":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6))."},"children":[]}]}]}]},"merchant_agreement_accepted":{"type":"boolean","description":"Sets whether this merchant has accepted the terms and conditions of the merchant agreement. Required."},"merchant_agreement_ip_address":{"type":"string","minLength":1,"description":"IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113). Required."},"merchant_agreement_timestamp":{"type":"string","minLength":1,"description":"Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z). Required."},"merchant_agreement_user_agent":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)). Required."},"children":[]}]}]}]},"refund_policy":{"type":"string","minLength":1,"description":"Include the value that best applies to the merchant's refund policy.","enum":["MERCHANDISE_EXCHANGE_ONLY","NO_REFUNDS","OTHER","WITHIN_30_DAYS"]},"volume_distribution_by_business_type":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant's distribution of credit card volume by business type. Sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume_distribution_by_business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be 100."},"children":[]}]}]}],"properties":{"business_to_business_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's business to business (between 0 and 100)."},"business_to_consumer_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's business to consumer (between 0 and 100)."},"consumer_to_consumer_volume_percentage":{"type":"integer","description":"Merchant's percentage of volume that is consumer to consumer (between 0 and 100)."},"other_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that isn't represented by the previous fields (between 0 and 100)."},"person_to_person_volume_percentage":{"type":"integer","description":"The percentage the merchant's volume that's person to person (between 0 and 100)."}}}},"required":["average_card_transfer_amount","business_description","card_volume_distribution","merchant_agreement_accepted","merchant_agreement_ip_address","merchant_agreement_timestamp","merchant_agreement_user_agent","refund_policy","volume_distribution_by_business_type"]},"entity":{"type":"object","properties":{"ach_max_transaction_amount":{"type":"integer","description":"The maximum amount (in cents) that can be processed for a single ACH transaction (max 12 characters)."},"amex_mid":{"type":"integer","description":"Assigned amexMid value. If a value is passed, it must be 10 or 11 digits."},"annual_card_volume":{"type":"integer","description":"The annual credit card sales (in cents) expected to be processed by this merchant (max 19 characters)."},"business_address":{"type":"object","description":"The primary address for the legal entity.","properties":{"city":{"type":"string","minLength":1,"description":"City (max 20 characters)."},"country":{"type":"string","minLength":1,"description":"3-Letter Country code (e.g. CAN)."},"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters)."},"line2":{"type":"string","description":"Second line of the address (max 35 characters).","minLength":1,"nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Postal code (max 7 characters)."},"region":{"type":"string","minLength":1,"description":"2-letter province or territory code."}}},"business_name":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's legal business name (max 120 characters)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass the owner's legal first name, last name, and middle initial."},"children":[]}]}]}]}]}]},"business_phone":{"type":"string","minLength":1,"description":"Customer service phone number where the merchant can be reached (max 10 characters)."},"business_tax_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nine-digit Business Number (BN) issued by the Canada Revenue Agency (CRA) for business tax purposes. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and they do not have a Business Number, use the sole proprietor's Social Insurance Number (SIN)."},"children":[]}]}]}]},"business_type":{"description":"Include the value that best applies to the merchant.","type":"string","enum":["ASSOCIATION_ESTATE_TRUST","CORPORATION","GENERAL_PARTNERSHIP","GOVERNMENT_AGENCY","INDIVIDUAL_SOLE_PROPRIETORSHIP","LIMITED_LIABILITY_COMPANY","LIMITED_PARTNERSHIP","PARTNERSHIP","TAX_EXEMPT_ORGANIZATION"]},"default_statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"discover_mid":{"description":"Assigned discoverMid value.","type":"integer"},"dob":{"type":"object","description":"The control owner's date of birth.","properties":{"day":{"type":"integer","description":"Day of birth (between 1 and 31).","minimum":1},"month":{"type":"integer","description":"Month of birth (between 1 and 12).","minimum":1},"year":{"type":"integer","description":"Year of birth (4-digit). Year must be greater than 1900.","minimum":1900}}},"doing_business_as":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (max 60 characters)."},"children":[]}]}]}]},"email":{"type":"string","minLength":1,"description":"The email address of the principal control owner where they can be reached (max 100 characters)."},"first_name":{"type":"string","minLength":1,"description":"The legal first name of the merchant's control owner (max 20 characters)."},"has_accepted_credit_cards_previously":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not passed."},"children":[]}]}]}]},"incorporation_date":{"type":"object","description":"The date the company was founded and registered.","properties":{"day":{"type":"integer","description":"Day business was incorporated (between 1 and 31)."},"month":{"type":"integer","description":"Month business was incorporated (between 1 and 12)."},"year":{"type":"integer","description":"Year business was incorporated (4-digit)."}}},"last_name":{"type":"string","minLength":1,"description":"The legal last name of the merchant's control owner (max 20 characters)."},"max_transaction_amount":{"type":"integer","description":"The maximum amount (in cents) that can be charged for a single transaction (max 12 characters)."},"mcc":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant Category Code ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that this merchant will be classified under. For a list of approved MCCs, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/approved-merchant-category-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved Merchant Category Codes."},"children":[]}]}]}]}]},"ownership_type":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values can be either: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUBLIC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate a publicly-traded company."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIVATE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for privately-held businesses."},"children":[]}]}]}]}]}],"enum":["PRIVATE","PUBLIC"]},"personal_address":{"allOf":[{"$ref":"#/components/schemas/address"}],"description":"The entity's personal address."},"phone":{"type":"string","minLength":1,"description":"The principal control owner's phone number (max 10 characters)."},"principal_percentage_ownership":{"type":"integer","description":"Percentage of the company owned by the principal control owner (min 0; max 100)."},"short_business_name":{"type":"string","description":"Abbreviated names of the business. If there are no abbreviated name, leave this field blank."},"tax_id":{"type":"string","description":"The control owner's Social Insurance Number (SIN). Required for identity verification. Not included in the response."},"title":{"type":"string","minLength":1,"description":"The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters)."},"url":{"type":"string","minLength":1,"description":"The URL of the merchant's public website."}}},"identity_roles":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of roles available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["SELLER"]}},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":"The identity type.","enum":["BUSINESS"]}},"required":["additional_underwriting_data"]}},"components/schemas/createIdentityRecipientBusiness":{"id":"components/schemas/createIdentityRecipientBusiness","kind":"json-schema","title":"Recipient (Business)","data":{"title":"Recipient (Business)","type":"object","properties":{"entity":{"type":"object","description":"Identifying information about the recipient business.","properties":{"business_address":{"description":"The primary address for the legal entity.","allOf":[{"$ref":"#/components/schemas/address"}]},"business_name":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The legal business name (max 120 characters). For an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass the owner's legal first name, last name, and middle initial."},"children":[]}]}]}],"nullable":true},"doing_business_as":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (max 60 characters)."},"children":[]}]}]}],"nullable":true},"first_name":{"type":"string","minLength":1,"description":"The legal first name of the recipient business's control owner (max 20 characters).","nullable":true},"last_name":{"type":"string","minLength":1,"description":"The legal last name of the recipient business's control owner (max 20 characters).","nullable":true},"personal_address":{"allOf":[{"$ref":"#/components/schemas/address"}],"description":"The billing address of the recipient business's control owner."}},"required":["business_address","business_name","doing_business_as","first_name","last_name","personal_address"]},"identity_roles":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of roles available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["RECIPIENT"]}},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":"The identity type.","enum":["BUSINESS"]}},"required":["entity"]}},"components/schemas/createIdentityRecipientPersonal":{"id":"components/schemas/createIdentityRecipientPersonal","kind":"json-schema","title":"Recipient (Personal)","data":{"title":"Recipient (Personal)","type":"object","properties":{"entity":{"type":"object","description":"Identifying information about the recipient.","properties":{"email":{"type":"string","description":"The email address of the buyer where they can be reached (max 100 characters)."},"first_name":{"type":"string","description":"The legal first name of the buyer (max 20 characters)."},"last_name":{"type":"string","description":"The legal last name of the buyer (max 20 characters)."},"personal_address":{"description":"The billing address of the buyer. This field is used for identity verification purposes.\n","allOf":[{"$ref":"#/components/schemas/address"}]},"phone":{"type":"string","description":"Phone number where the buyer can be reached."}},"required":["first_name","last_name","personal_address"]},"identity_roles":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of roles available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["RECIPIENT"]}},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":"The identity type.","enum":["PERSONAL"]}},"required":["entity"]}},"components/schemas/createIdentityBuyer":{"id":"components/schemas/createIdentityBuyer","kind":"json-schema","title":"Buyer","data":{"title":"Buyer","type":"object","properties":{"entity":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The underwriting details required to verify an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"email":{"type":"string","description":"The email address of the buyer where they can be reached (max 100 characters)."},"first_name":{"type":"string","description":"The legal first name of the buyer (max 20 characters)."},"last_name":{"type":"string","description":"The legal last name of the buyer (max 20 characters)."},"personal_address":{"description":"The billing address of the buyer. This field is used for identity verification purposes.\n","allOf":[{"$ref":"#/components/schemas/address"}]},"phone":{"type":"string","description":"Phone number where the buyer can be reached."}}},"identity_roles":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of roles available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string","enum":["BUYER"]}},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type."},"children":[]}]}]}],"enum":["BUSINESS","PERSONAL"]}},"required":["entity"]}},"components/schemas/createIdentityBuyerBlank":{"id":"components/schemas/createIdentityBuyerBlank","kind":"json-schema","title":"Buyer - Blank","data":{"title":"Buyer - Blank","allOf":[{"$ref":"#/components/schemas/createIdentityBuyer"}]}},"components/schemas/createIdentitySenderAndRecipientPersonal":{"id":"components/schemas/createIdentitySenderAndRecipientPersonal","kind":"json-schema","title":"Sender & Recipient (Personal)","data":{"title":"Sender & Recipient (Personal)","type":"object","properties":{"entity":{"type":"object","description":"Identifying information about the recipient.","properties":{"first_name":{"type":"string","description":"The legal first name of the buyer (max 20 characters)."},"last_name":{"type":"string","description":"The legal last name of the buyer (max 20 characters)."},"personal_address":{"description":"The billing address of the buyer. This field is used for identity verification purposes.\n","allOf":[{"$ref":"#/components/schemas/address"}]}},"required":["first_name","last_name","personal_address"]},"identity_roles":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of roles available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minItems":2,"uniqueItems":true,"items":{"type":"string","enum":["RECIPIENT","SENDER"]}},"type":{"type":"string","description":"The identity type.","enum":["PERSONAL"]}},"required":["entity","identity_roles","type"]}},"components/schemas/createIdentitySenderAndRecipientBusiness":{"id":"components/schemas/createIdentitySenderAndRecipientBusiness","kind":"json-schema","title":"Sender & Recipient (Business)","data":{"title":"Sender & Recipient (Business)","type":"object","properties":{"entity":{"type":"object","description":"Identifying information about the recipient business.","properties":{"business_address":{"description":"The primary address for the legal entity.","allOf":[{"$ref":"#/components/schemas/address"}]},"business_name":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The legal business name (max 120 characters). For an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass the owner's legal first name, last name, and middle initial."},"children":[]}]}]}],"nullable":true},"doing_business_as":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (max 60 characters)."},"children":[]}]}]}],"nullable":true},"first_name":{"type":"string","minLength":1,"description":"The legal first name of the recipient business's control owner (max 20 characters).","nullable":true},"last_name":{"type":"string","minLength":1,"description":"The legal last name of the recipient business's control owner (max 20 characters).","nullable":true},"personal_address":{"allOf":[{"$ref":"#/components/schemas/address"}],"description":"The billing address of the recipient business's control owner."}},"required":["business_address","business_name","doing_business_as","first_name","last_name","personal_address"]},"identity_roles":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The set of roles available to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minItems":2,"uniqueItems":true,"items":{"type":"string","enum":["RECIPIENT","SENDER"]}},"type":{"type":"string","description":"The identity type.","enum":["BUSINESS"]}},"required":["entity","identity_roles","type"]}},"components/schemas/updateIdentity":{"id":"components/schemas/updateIdentity","kind":"json-schema","title":"Update Identity","data":{"title":"Update Identity","type":"object","properties":{"entity":{"type":"object","description":"Identifying information about the entity.","properties":{"email":{"type":"string","description":"The email address of the entity (max 100 characters)."},"first_name":{"type":"string","description":"The legal first name of the entity (max 20 characters)."},"last_name":{"type":"string","description":"The legal last name of the entity (max 20 characters)."},"personal_address":{"allOf":[{"$ref":"#/components/schemas/address"}],"description":"The billing address of the entity. This field is used for identity verification purposes."},"phone":{"type":"string","description":"Phone number where the entity can be reached."}}},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/createAssociatedIdentity":{"id":"components/schemas/createAssociatedIdentity","kind":"json-schema","title":"createAssociatedIdentity","data":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/entity"}}}},"components/schemas/refunds_disabled_merchant":{"id":"components/schemas/refunds_disabled_merchant","kind":"json-schema","title":"refunds_disabled_merchant","data":{"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":"A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" disables refunds for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including both referenced and unreferenced refunds."},"children":[]}]}]}]}},"components/schemas/identity_link":{"id":"components/schemas/identity_link","kind":"json-schema","title":"identity_link","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}},"components/schemas/merchant_profiles":{"id":"components/schemas/merchant_profiles","kind":"json-schema","title":"merchant_profiles","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}},"components/schemas/merchant":{"id":"components/schemas/merchant","kind":"json-schema","title":"Merchant Schema","data":{"title":"Merchant Schema","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the resource."},"children":[]}]}]}]},"card_cvv_required":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to require the card's CVV code."},"children":[]}]}]}]},"card_expiration_date_required":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to require the card's expiration date."},"children":[]}]}]}]},"card_network_details":{"type":"object","nullable":true},"convenience_charges_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accept convenience fees and/or service fees."},"children":[]}]}]}]},"country":{"description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s country."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/country"}]},"creating_transfer_from_report_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to automatically create "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once settlement reports get generated."},"children":[]}]}]}]},"currencies":{"type":"array","description":"ISO 4217 3-letter currency code.","nullable":true,"items":{"$ref":"#/components/schemas/currency"}},"default_partial_authorization_enabled":{"type":"boolean","default":false,"description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable partial authorizations for a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"Partial authorizations enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to collect a portion of the amount if the cardholder doesn't have the funds to cover the entire amount on their card."},"children":[]}]}]}]}]},"disbursements_ach_pull_enabled":{"type":"boolean","description":"Indicates whether standard ACH pull disbursements (debits) are enabled."},"disbursements_ach_push_enabled":{"type":"boolean","description":"Indicates whether standard ACH push disbursements (credits) are enabled."},"disbursements_card_pull_enabled":{"type":"boolean","description":"Indicates whether card pull disbursements are enabled."},"disbursements_card_push_enabled":{"type":"boolean","description":"Indicates whether card push disbursements are enabled."},"disbursements_same_day_ach_pull_enabled":{"type":"boolean","description":"Indicates whether same-day ACH pull disbursements (debits) are enabled, allowing funds to be withdrawn from an account via same-day ACH transfer."},"disbursements_same_day_ach_push_enabled":{"type":"boolean","description":"Indicates whether same-day ACH push disbursements (credits) are enabled, allowing funds to be sent to an account via same-day ACH transfer."},"fee_ready_to_settle_upon":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details how the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" settles fees."},"children":[]}]}]}],"enum":["RECONCILIATION","SUCCESSFUL_CAPTURE","PROCESSOR_WINDOW","CONFIGURABLE_WINDOW"]},"first_approved_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field shows the timestamp when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was first approved. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been approved yet, the value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"gateway":{"type":"string","description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment gateway."},"children":[]}]}]}],"nullable":true},"gross_settlement_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable gross settlements."},"children":[]}]}]}]},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"instant_payouts_card_push_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to allow the merchant to be enabled for settlement instant payouts."},"children":[]}]}]}],"default":false},"is_terminated":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to terminate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A merchant can only be terminated if its current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onboarding_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"level_two_level_three_data_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Level 2 and Level 3 processing. Default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"loan_repayment":{"type":"boolean","default":false,"nullable":true,"description":"Whether the merchant is able to support loan repayment on the card networks.\n"},"mcc":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant Category Code ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that this merchant will be classified under. For a list of approved MCCs, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/approved-merchant-category-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved Merchant Category Codes."},"children":[]}]}]}]}],"nullable":true},"merchant_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The legal name saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"merchant_profile":{"type":"string","description":"Details if a merchant's info was submitted to third-party processors for provisioning."},"microdeposit_verification_required_buyer":{"type":"boolean","description":"Whether microdeposit verification is required for buyers."},"microdeposit_verification_required_sender":{"type":"boolean","description":"Whether microdeposit verification is required for senders."},"microdeposit_verification_send_email_enabled":{"type":"boolean","description":"Whether Finix emails the bank account owner when a microdeposit verification is created."},"mid":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"onboarding_state":{"type":"string","enum":["APPROVED","PROVISIONING","REJECTED","UPDATE_REQUESTED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details the state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant's"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" onboarding."},"children":[]}]}]}]},"processing_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if transaction processing is enabled for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"processor":{"type":"string","description":"Name of the transaction processor.","enum":["FINIX_V1","DUMMY_V1"]},"processor_details":{"type":"object","description":"Additional details specific to the processor.","properties":{"mid":{"type":"string"},"api_key":{"type":"string"}}},"pending_refunds_strategy":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The strategy used to hold refunds for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Refunds stay in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the merchant's settlement balance covers them. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds/pending-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending refunds"},"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":"code","inline":true,"attributes":{"content":"ROLE_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" credentials can set the following strategies:"},"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":"SEVEN_DAY_DELAYED_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Refunds are held in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for up to 7 days to be covered by settlement funds. After 7 days, Finix debits the merchant's bank account to cover the refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_DAY_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Finix issues a debit adjustment near settlement close if the settlement can't cover the refund."},"children":[]}]}]}]}],"enum":["NONE","SEVEN_DAY_DELAYED_ADJUSTMENT","SAME_DAY_ADJUSTMENT"],"nullable":true},"ready_to_settle_upon":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details how transactions captured by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are settled."},"children":[]}]}]}],"enum":["RECONCILIATION","SUCCESSFUL_CAPTURE","PROCESSOR_WINDOW","CONFIGURABLE_WINDOW"]},"ready_to_settle_upon_delay_alignment":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether transaction settlement should be delayed to synchronize the timing of all transactions, including both card and ACH, ensuring they are settled together."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values 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":"code","inline":true,"attributes":{"content":"ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Align all transactions to match the timing of ACH settlements, so card transactions settle at the same speed as ACH transactions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Default behavior where card transactions settle the next day (T+1) and ACH transactions settle two days later (T+2)."},"children":[]}]}]}]}],"enum":["ACH","NONE"]},"refunds_disabled":{"$ref":"#/components/schemas/refunds_disabled_merchant"},"rent_surcharges_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accept rent charges."},"children":[]}]}]}]},"settlement_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if settlement approvals are enabled for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only set this value to false."},"children":[]}]}]}]},"settlement_funding_identifier":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes additional information (like the MID or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" name) when submitting funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to processors."},"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":"UNSET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No additional details get provided to the processor."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MID_AND_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the date the funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was submitted (Date is in UTC). e.g "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MID:12345678-20220225"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MID_AND_MERCHANT_NAME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant#name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (white spaces will be removed). e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MID:12345678-NameOfMerchant"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These details appear alongside the seller's payout in their bank account as a description of the deposit."},"children":[]}]}]}],"enum":["UNSET","MID_AND_DATE","MID_AND_MERCHANT_NAME"],"default":"UNSET"},"settlement_queue_mode":{"type":"string","description":[{"$$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":"settlement_queue_mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANUAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Finix will automatically place all transactions (Sales, Fees, Refunds, and ACH Returns) into a settlement queue that you can manage. Each transaction will have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"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":"When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created, it will not be placed into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is explicitly released."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: We require the release of all settlement queue entries within 30 days of creation."},"children":[]}]}]}],"enum":["UNSET","MANUAL"]},"surcharges_enabled":{"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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accept surcharge fees. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"termination_details":{"type":"object","nullable":true,"properties":{"terminated_at":{"type":"string","title":"CreatedAt","format":"date-time","example":"2024-09-16T13:11:36.72Z","description":"Timestamp indicating when the termination occurred."},"reason":{"type":"string","description":"The reason for termination. Finix reserves the right to return enums that are not listed here.","enum":["CHURNED","COMPLIANCE_VIOLATION","EXCESSIVE_ACH_RETURNS","EXCESSIVE_CHARGEBACKS","FRAUD","IDENTITY_THEFT","ILLEGAL_TRANSACTIONS","INSOLVENCY","OTHER","PCI_VIOLATION","PROCESSOR_MIGRATION","SUSPECTED_FRAUD","UNSUPPORTED_BUSINESS_TYPE","UNUSUAL_ACTIVITY","VIOLATED_MERCHANT_TERMS_OF_SERVICE"]},"description":{"type":"string","description":"An explanation that provides context for the termination.","maxLength":1000},"terminated_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The role that initiated the termination. If the API key belongs to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role, the following values will be returned:"},"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 the role is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PLATFORM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLATFORM_USER"},"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":"If the role is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it will return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PARTNER_USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["PLATFORM_USER","PARTNER_USER"]},"terminated_by_user_id":{"type":"string","description":[{"$$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":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID of the user who initiated the termination of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" account."},"children":[]}]}]}]}}},"unreferenced_refund_card_present_enabled":{"type":"boolean","description":"Indicates if the merchant is allowed to process unreferenced refunds initiated through card-present transactions on Finix terminals."},"unreferenced_refund_manual_entry_enabled":{"type":"boolean","default":false,"description":"Indicates if merchant is allowed to process unreferenced refunds initiated through manual card entry on Finix terminals."},"verification":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was submitted to verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"self":{"$ref":"#/components/schemas/self"},"identity":{"$ref":"#/components/schemas/identity_link"},"verifications":{"$ref":"#/components/schemas/verifications"},"merchant_profile":{"$ref":"#/components/schemas/merchant_profiles"},"merchant_profiles":{"$ref":"#/components/schemas/merchant_profiles"},"verification":{"$ref":"#/components/schemas/verifications"},"application":{"$ref":"#/components/schemas/application_link"}}}}}},"components/schemas/processor_request":{"id":"components/schemas/processor_request","kind":"json-schema","title":"processor_request","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the acquiring processor. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for your Sandbox. For more details on which processor to use, reach out to your Finix point of contact or email "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/getting-started/support-at-finix/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","nullable":false,"enum":["DUMMY_V1","FINIX_V1"]}},"components/schemas/createMerchantMinimalFields":{"id":"components/schemas/createMerchantMinimalFields","kind":"json-schema","title":"Merchant - Minimal Fields","data":{"title":"Merchant - Minimal Fields","type":"object","properties":{"processor":{"$ref":"#/components/schemas/processor_request"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["processor"]}},"components/schemas/createMerchant":{"id":"components/schemas/createMerchant","kind":"json-schema","title":"Merchant - All Fields","data":{"title":"Merchant - All Fields","type":"object","properties":{"default_partial_authorization_enabled":{"type":"boolean","default":false,"description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable partial authorizations for a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"Partial authorizations enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to collect a portion of the amount if the cardholder doesn't have the funds to cover the entire amount on their card."},"children":[]}]}]}]}]},"loan_repayment":{"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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process debt loan repayment. Only MCCs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6012"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6051"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are eligible."},"children":[]}]}]}]},"processor":{"$ref":"#/components/schemas/processor_request"},"refunds_disabled":{"$ref":"#/components/schemas/refunds_disabled_merchant"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["processor"]}},"components/schemas/createMerchantCardPresentEnabled":{"id":"components/schemas/createMerchantCardPresentEnabled","kind":"json-schema","title":"Merchant - Card Present Enabled","data":{"title":"Merchant - Card Present Enabled","type":"object","properties":{"processor":{"$ref":"#/components/schemas/processor_request"}},"required":["processor"]}},"components/schemas/createMerchantDefaultPartialAuthorization":{"id":"components/schemas/createMerchantDefaultPartialAuthorization","kind":"json-schema","title":"Merchant - Default Partial Authorization Enabled","data":{"title":"Merchant - Default Partial Authorization Enabled","type":"object","properties":{"default_partial_authorization_enabled":{"type":"boolean","default":false,"description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable partial authorizations for a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"Partial authorizations enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to collect a portion of the amount if the cardholder doesn't have the funds to cover the entire amount on their card."},"children":[]}]}]}]}]},"processor":{"$ref":"#/components/schemas/processor_request"}},"required":["processor"]}},"components/schemas/createMerchantLoanRepaymentEnabled":{"id":"components/schemas/createMerchantLoanRepaymentEnabled","kind":"json-schema","title":"Merchant - Loan Repayment Enabled","data":{"title":"Merchant - Loan Repayment Enabled","type":"object","properties":{"loan_repayment":{"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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process debt loan repayment. Only MCCs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6012"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6051"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are eligible."},"children":[]}]}]}]},"processor":{"$ref":"#/components/schemas/processor_request"}},"required":["processor"]}},"components/schemas/createMerchantRefundsDisabled":{"id":"components/schemas/createMerchantRefundsDisabled","kind":"json-schema","title":"Merchant - Refunds Disabled","data":{"title":"Merchant - Refunds Disabled","type":"object","properties":{"processor":{"$ref":"#/components/schemas/processor_request"},"refunds_disabled":{"$ref":"#/components/schemas/refunds_disabled_merchant"}},"required":["processor"]}},"components/schemas/model":{"id":"components/schemas/model","kind":"json-schema","title":"model","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The model type of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["IOS_TAP_TO_PAY","PAX_A800","PAX_A920PRO","PAX_D135","PAX_IM30"]}},"components/schemas/createMerchantDevice":{"id":"components/schemas/createMerchantDevice","kind":"json-schema","title":"createMerchantDevice","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema for request to create a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"app_bundle_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Apple app bundle identifier for the iOS app that will use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"model"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IOS_TAP_TO_PAY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"configuration":{"$ref":"#/components/schemas/device_configuration"},"description":{"type":"string","description":"Additional information about device (e.g. self serving terminal)."},"integration_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defines the operating mode of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_APP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" devices operate within the standard Finix ecosystem. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SDK"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" devices are for customers who are building their own PAX app."},"children":[]}]}]}],"enum":["PAYMENT_APP","SDK"]},"model":{"$ref":"#/components/schemas/model"},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"serial_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The serial number of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}},"required":["model","name","serial_number"]}},"components/schemas/createDeviceIOSTapToPay":{"id":"components/schemas/createDeviceIOSTapToPay","kind":"json-schema","title":"Create a Device - Model IOS_TAP_TO_PAY","data":{"title":"Create a Device - Model IOS_TAP_TO_PAY","allOf":[{"$ref":"#/components/schemas/createMerchantDevice"}]}},"components/schemas/createDevicePAXA800":{"id":"components/schemas/createDevicePAXA800","kind":"json-schema","title":"Create a Device - Model PAX_A800","data":{"title":"Create a Device - Model PAX_A800","allOf":[{"$ref":"#/components/schemas/createMerchantDevice"}]}},"components/schemas/createDevicePAXA920Pro":{"id":"components/schemas/createDevicePAXA920Pro","kind":"json-schema","title":"Create a Device - Model PAX_A920PRO","data":{"title":"Create a Device - Model PAX_A920PRO","allOf":[{"$ref":"#/components/schemas/createMerchantDevice"}]}},"components/schemas/createDevicePAXD135":{"id":"components/schemas/createDevicePAXD135","kind":"json-schema","title":"Create a Device - Model PAX_D135","data":{"title":"Create a Device - Model PAX_D135","allOf":[{"$ref":"#/components/schemas/createMerchantDevice"}]}},"components/schemas/createDevicePAXIM30":{"id":"components/schemas/createDevicePAXIM30","kind":"json-schema","title":"Create a Device - Model PAX_IM30","data":{"title":"Create a Device - Model PAX_IM30","allOf":[{"$ref":"#/components/schemas/createMerchantDevice"}]}},"components/schemas/createDeviceSDKMode":{"id":"components/schemas/createDeviceSDKMode","kind":"json-schema","title":"Create a Device - SDK Mode","data":{"title":"Create a Device - SDK Mode","allOf":[{"$ref":"#/components/schemas/createMerchantDevice"}]}},"components/schemas/createDeviceStandalone":{"id":"components/schemas/createDeviceStandalone","kind":"json-schema","title":"Create a Device - Surcharges - Standalone Mode","data":{"title":"Create a Device - Surcharges - Standalone Mode","allOf":[{"$ref":"#/components/schemas/createMerchantDevice"}]}},"components/schemas/updateMerchantDisableProcessing":{"id":"components/schemas/updateMerchantDisableProcessing","kind":"json-schema","title":"Disable Processing","data":{"title":"Disable Processing","type":"object","properties":{"processing_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if transaction processing is enabled for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateMerchantDisableSettlements":{"id":"components/schemas/updateMerchantDisableSettlements","kind":"json-schema","title":"Disable Settlements","data":{"title":"Disable Settlements","type":"object","properties":{"settlement_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if settlement approvals are enabled for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ROLE_PARTNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can only set this value to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateMerchantEnableBuyerCharges":{"id":"components/schemas/updateMerchantEnableBuyerCharges","kind":"json-schema","title":"Enable Buyer Charges","data":{"title":"Enable Buyer Charges","type":"object","properties":{"convenience_charges_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accept convenience fees and/or service fees."},"children":[]}]}]}]},"rent_surcharges_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accept rent charges."},"children":[]}]}]}]},"surcharge_fees_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accept surcharge fees."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateMerchantEnableL2L3Processing":{"id":"components/schemas/updateMerchantEnableL2L3Processing","kind":"json-schema","title":"Enable Level 2/3 Processing","data":{"title":"Enable Level 2/3 Processing","type":"object","properties":{"level_two_level_three_data_enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for Level 2 and Level 3 processing. Default value is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateMerchantEnableLoanRepayment":{"id":"components/schemas/updateMerchantEnableLoanRepayment","kind":"json-schema","title":"Enable Loan Repayment","data":{"title":"Enable Loan Repayment","type":"object","properties":{"loan_repayment":{"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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to process debt loan repayment. Only MCCs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6012"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6051"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are eligible."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateMerchantEnablePartialAuthorizations":{"id":"components/schemas/updateMerchantEnablePartialAuthorizations","kind":"json-schema","title":"Enable Partial Authorizations","data":{"title":"Enable Partial Authorizations","type":"object","properties":{"default_partial_authorization_enabled":{"type":"boolean","description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable partial authorizations for a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"Partial authorizations enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to collect a portion of the amount if the cardholder doesn't have the funds to cover the entire amount on their card."},"children":[]}]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateMerchantEnableSameDayACH":{"id":"components/schemas/updateMerchantEnableSameDayACH","kind":"json-schema","title":"Enable Disbursements Same-Day ACH Push & Pull","data":{"title":"Enable Disbursements Same-Day ACH Push & Pull","type":"object","properties":{"disbursements_same_day_ach_pull_enabled":{"type":"boolean","description":"Indicates whether same-day ACH pull disbursements (debits) are enabled, allowing funds to be withdrawn from an account via same-day ACH transfer."},"disbursements_same_day_ach_push_enabled":{"type":"boolean","description":"Indicates whether same-day ACH push disbursements (credits) are enabled, allowing funds to be sent to an account via same-day ACH transfer."},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateMerchantSettlementQueue":{"id":"components/schemas/updateMerchantSettlementQueue","kind":"json-schema","title":"Enable Settlement Queue","data":{"title":"Enable Settlement Queue","type":"object","properties":{"settlement_queue_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANUAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to enable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use the Settlement Queue."},"children":[]}]}]}],"default":"UNSET","enum":["MANUAL","UNSET"]}}}},"components/schemas/updateMerchantTerminate":{"id":"components/schemas/updateMerchantTerminate","kind":"json-schema","title":"Terminate Merchant","data":{"title":"Terminate Merchant","type":"object","properties":{"is_terminated":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to terminate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A merchant can only be terminated if its current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onboarding_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"termination_details":{"type":"object","properties":{"description":{"type":"string","description":"An explanation that provides context for the termination.","maxLength":1000},"reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason for termination. Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_terminated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["CHURNED","COMPLIANCE_VIOLATION","EXCESSIVE_ACH_RETURNS","EXCESSIVE_CHARGEBACKS","FRAUD","IDENTITY_THEFT","ILLEGAL_TRANSACTIONS","INSOLVENCY","OTHER","PCI_VIOLATION","PROCESSOR_MIGRATION","SUSPECTED_FRAUD","UNSUPPORTED_BUSINESS_TYPE","UNUSUAL_ACTIVITY","VIOLATED_MERCHANT_TERMS_OF_SERVICE"]}}}}}},"components/schemas/merchant_verification":{"id":"components/schemas/merchant_verification","kind":"json-schema","title":"Merchant Verification","data":{"type":"object","title":"Merchant Verification","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"type":"string","$ref":"#/components/schemas/application_id"},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"default":null},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent for verification."},"children":[]}]}]}]},"merchant_identity":{"type":"string","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"messages":{"type":"array","description":"A codified list of reasons the verification request failed.","items":{"type":"string"},"default":[]},"outcome_summary":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A message providing additional context about why the verification request failed, available for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" merchants only."},"children":[]}]}]}],"nullable":true,"default":null},"outcomes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A codified list of reasons the verification request failed, available for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" merchants only."},"children":[]}]}]}],"items":{"type":"object","properties":{"outcome_code":{"type":"string","description":"A code indicating the reason the verification request failed. Finix reserves the right to return enums that are not listed here.","enum":["BANK_STATEMENT_ONE_MONTH_REQUESTED","BANK_STATEMENT_THREE_MONTHS_REQUESTED","BUSINESS_ADDRESS_DOCUMENT_REQUESTED","BUSINESS_INCORPORATION_DOCUMENT_REQUESTED","BUSINESS_REGISTRATION_DOCUMENT_REQUESTED","BUSINESS_TAX_EXEMPTION_STATUS_DOCUMENT_REQUESTED","BUSINESS_TAX_ID_DOCUMENT_REQUESTED","INVALID_BANK_STATEMENT_ONE_MONTH","INVALID_BANK_STATEMENT_THREE_MONTHS","INVALID_BUSINESS_ADDRESS","INVALID_BUSINESS_ADDRESS_DOCUMENT","INVALID_BUSINESS_DBA","INVALID_BUSINESS_DESCRIPTION","INVALID_BUSINESS_INCORPORATION_DATE","INVALID_BUSINESS_INCORPORATION_DOCUMENT","INVALID_BUSINESS_MCC","INVALID_BUSINESS_NAME","INVALID_BUSINESS_OWNERSHIP_TYPE","INVALID_BUSINESS_PHONE","INVALID_BUSINESS_REGISTRATION_DOCUMENT","INVALID_BUSINESS_TAX_EXEMPTION_STATUS_DOCUMENT","INVALID_BUSINESS_TAX_ID","INVALID_BUSINESS_TAX_ID_DOCUMENT","INVALID_BUSINESS_TYPE","INVALID_BUSINESS_WEBSITE","INVALID_OWNER_ADDRESS","INVALID_OWNER_BIRTHDATE","INVALID_OWNER_EMAIL","INVALID_OWNER_FIRST_NAME","INVALID_OWNER_GOVERNMENT_ISSUED_PHOTO_ID","INVALID_OWNER_LAST_NAME","INVALID_OWNER_PHONE","INVALID_OWNER_TAX_ID","INVALID_OWNER_TAX_ID_DOCUMENT","INVALID_OWNER_TITLE","INVALID_PAYMENT_INSTRUMENT_ACCOUNT_NUMBER","INVALID_PAYMENT_INSTRUMENT_BANK_CODE","INVALID_PAYMENT_INSTRUMENT_NAME","OWNER_GOVERNMENT_ISSUED_PHOTO_ID_REQUESTED","OWNER_TAX_ID_DOCUMENT_REQUESTED","PROCESSING_STATEMENT_REQUESTED"]},"outcome_message":{"type":"string","description":"An optional message from the Finix underwriting team providing additional context about the outcome code. Only visible to Applications, not submerchants.","nullable":true,"default":null},"remediation_details":{"type":"object","description":"Details about the action required to remediate the verification failure.","nullable":true,"properties":{"entity_id":{"type":"string","description":"The ID of the entity that needs to be updated."},"entity_type":{"type":"string","description":"The type of entity that needs to be updated.","enum":["IDENTITY"]},"field_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the field that needs to be updated. Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIELD_UPDATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"file_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of file that needs to be uploaded. Returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FILE_UPLOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"enum":["BANK_STATEMENT_ONE_MONTH","BANK_STATEMENT_THREE_MONTHS","BUSINESS_ADDRESS_DOCUMENT","BUSINESS_INCORPORATION_DOCUMENT","BUSINESS_REGISTRATION_DOCUMENT","BUSINESS_TAX_EXEMPTION_STATUS_DOCUMENT","BUSINESS_TAX_ID_DOCUMENT","OWNER_GOVERNMENT_ISSUED_PHOTO_ID","OWNER_TAX_ID_DOCUMENT","PROCESSING_STATEMENT"]},"type":{"type":"string","description":"The type of remediation action required.","enum":["FIELD_UPDATE","FILE_UPLOAD"]}}}}},"nullable":true,"default":null},"payment_instrument":{"type":"string","description":"This field is not applicable to merchant verification.","nullable":true,"default":null},"payment_instrument_verification_details":{"type":"object","description":"This object is not applicable to merchant verification.","properties":{"pull_from_card_cross_border":{"type":"string","description":"This object is not applicable to merchant verification.","nullable":true,"default":null},"pull_from_card_domestic":{"type":"string","description":"This object is not applicable to merchant verification.","nullable":true,"default":null},"push_to_card_domestic":{"type":"string","description":"This object is not applicable to merchant verification.","nullable":true,"default":null},"push_to_card_cross_border":{"type":"string","description":"This object is not applicable to merchant verification.","nullable":true,"default":null},"card_type":{"type":"string","description":"This object is not applicable to merchant verification.","nullable":true,"default":null},"billing_currency":{"type":"string","description":"This object is not applicable to merchant verification.","nullable":true,"default":null},"issuer_country":{"type":"string","description":"This object is not applicable to merchant verification.","nullable":true,"default":null},"name_verification_results":{"description":"Details the results of verifying the cardholder's name. Not applicable to merchant verification.","type":"object","nullable":true,"default":null,"properties":{"first_name":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's first name."},"last_name":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's last name."},"middle_name":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's middle name."},"name":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's full name."}}}}},"processor":{"type":"string","description":"Name of the verification processor.","enum":["FINIX_V1","DUMMY_V1"]},"raw":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Raw response from the processor. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SELLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Merchants, please use the newer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outcomes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outcome_summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields."},"children":[]}]}]}],"anyOf":[{"type":"array","nullable":true,"items":{"type":"object","properties":{"description":{"type":"string","description":"A description of the reason the verification failed."},"outcome_code":{"type":"string","description":"A code indicating the reason the verification failed."},"remediation_item":{"type":"string","description":"Steps the merchant can take to resolve the verification failure."}}}},{"type":"object","nullable":true},{"type":"string","nullable":true}]},"reverification_reason":{"type":"object","description":"The reason the merchant was re-verified.","nullable":true,"properties":{"initiated_by":{"type":"string","description":"The initiator of the re-verification.","nullable":true},"reason_description":{"type":"string","description":"A description of the reason for re-verification.","nullable":true},"review_type":{"type":"string","description":"The type of review.","nullable":true}}},"state":{"type":"string","description":"The state of the verification request.","enum":["PENDING","FAILED","SUCCEEDED"]},"tags":{"$ref":"#/components/schemas/tags"},"trace_id":{"type":"string","description":"An ID used for tracking the verification request."},"type":{"type":"string","description":"Details the type of resource getting verified.","enum":["MERCHANT"]},"sub_type":{"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 "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/gateway-integrations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" linked to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the merchant is not linked to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this field will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". At this time, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CYBERSOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only supported "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Gateway Integration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["CYBERSOURCE"],"nullable":true,"default":null},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"self":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"merchant":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent in the verification request."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"application":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with this resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}}}}}},"components/schemas/microdeposit":{"id":"components/schemas/microdeposit","kind":"json-schema","title":"Microdeposit","data":{"type":"object","title":"Microdeposit","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Microdeposit represents the $0.01 verification deposit sent to a bank account. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/microdeposit-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Microdeposit Verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":"The ID of the Microdeposit resource.","example":"microdeposit_8cFbWq5n2KjXcVbtQkC1U1"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"$ref":"#/components/schemas/application_id"},"currency":{"$ref":"#/components/schemas/currency"},"expires_at":{"type":"string","format":"date-time","description":"The timestamp indicating when the 30-day verification window closes. A microdeposit that isn't verified by this time expires."},"failure_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details why the verification failed. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["INVALID_BANK_ACCOUNT_ROUTING_NUMBER","MICRODEPOSIT_RETURNED","MICRODEPOSIT_VERIFICATION_ATTEMPTS_EXCEEDED","MICRODEPOSIT_VERIFICATION_EXPIRED","TOTAL_MICRODEPOSIT_ATTEMPTS_EXCEEDED_ACCOUNT_LOCKED"],"nullable":true},"failure_message":{"type":"string","description":"Details why the verification failed.\n","nullable":true},"instrument":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the bank account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being verified."},"children":[]}]}]}],"example":"PIkfiTDWYhQ4VbtQkC1U1ceJ"},"rail":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment rail Finix used to send the $0.01 microdeposit."},"children":[]}]}]}],"example":"RTP"},"state":{"type":"string","description":"The state of the Microdeposit.","enum":["PENDING","VERIFIED","FAILED"]},"verification_attempts":{"type":"integer","description":"The number of code submission tries used so far.","example":1},"verification_attempts_remaining":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of code submission tries left for this microdeposit. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" once the verification has failed."},"children":[]}]}]}],"example":2},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"instrument":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the bank account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being verified."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}}}}}}},"components/schemas/created_via":{"id":"components/schemas/created_via","kind":"json-schema","title":"created_via","data":{"type":"string","description":"The method by which the resource was created.","enum":["API","ACCOUNT_UPDATER","SETTLEMENT_REPORT","SYSTEM","TOKEN_IMPORT"]}},"components/schemas/account_updater_enabled_card":{"id":"components/schemas/account_updater_enabled_card","kind":"json-schema","title":"account_updater_enabled_card","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enabled, Finix automatically checks for updates with card networks. This Account Updater functionality:"},"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":"Automatically updates card details (e.g., number or expiration date) to maintain continuity of charges, increasing authorization rates."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Saves the cardholder the hassle of updating card details across "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for each of their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscriptions"},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cards created before the feature is enabled are unaffected by default. To include these cards, you can manually enable the Account Updater functionality for each card individually using a PUT request. Once enabled, you can link the card to this API call to trigger updates with card networks."},"children":[]}]}]}],"default":false}},"components/schemas/identity_id":{"id":"components/schemas/identity_id","kind":"json-schema","title":"identity_id","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the resource."},"children":[]}]}]}]}},"components/schemas/network_token_enabled_card":{"id":"components/schemas/network_token_enabled_card","kind":"json-schema","title":"network_token_enabled_card","data":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When enabled, a \"network token\" replaces raw card details (e.g., the 16-digit PAN and expiration date) for transactions. Network tokens have several benefits:"},"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 token offers increased authorization rates, even for lost or stolen cards, as it remains valid while the physical card is replaced."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Visa reduces interchange fees when using network tokens."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens enhance security by replacing card details with a non-sensitive string that is usable only within the Finix system."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Cards created before the feature is enabled are unaffected. To include them, update the individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"network_token_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":false}},"components/schemas/name_verification_results":{"id":"components/schemas/name_verification_results","kind":"json-schema","title":"name_verification_results","data":{"type":"object","nullable":true,"properties":{"first_name_verification":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's first name."},"last_name_verification":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's last name."},"middle_name_verification":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's middle name."},"name_verification":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's full name."}}}},"components/schemas/payment_instrument_card":{"id":"components/schemas/payment_instrument_card","kind":"json-schema","title":"Payment Instrument - Card","data":{"type":"object","title":"Payment Instrument - Card","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"created_via":{"$ref":"#/components/schemas/created_via"},"account_updater_enabled":{"$ref":"#/components/schemas/account_updater_enabled_card"},"address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the card owner. Including a postal or zip code when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can lower the interchange on credit card transactions."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/address"}]},"address_verification":{"type":"string","enum":["POSTAL_CODE_AND_STREET_MATCH","STREET_MATCH","POSTAL_CODE_MATCH","NO_ADDRESS","NO_MATCH","NOT_SUPPORTED","UNKNOWN"],"description":[{"$$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":"Details the results of verifying "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the issuing bank."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"address"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" gets updated."},"children":[]}]}]}]}]},"application":{"$ref":"#/components/schemas/application_id"},"bin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Identification number for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"brand":{"type":"string","enum":["UNKNOWN","DINERS_CLUB_INTERNATIONAL","DANKORT","MIR","TROY","UATP","CHINA_T_UNION","CHINA_UNION_PAY","AMERICAN_EXPRESS","VERVE","RUPAY","DISCOVER","JCB","MASTERCARD","INTERPAYMENT","INSTAPAYMENT","MAESTRO","VISA","LANKAPAY","DINERS_CLUB","INTERAC"],"description":[{"$$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":"brand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the card saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"card_type":{"type":"string","enum":["CREDIT","DEBIT","HSA_FSA","NON_RELOADABLE_PREPAID","RELOADABLE_PREPAID","UNKNOWN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of payment card saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"country":{"$ref":"#/components/schemas/country"},"currency":{"$ref":"#/components/schemas/currency"},"disabled_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code indicating why the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was disabled. This field is set when:"},"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 system automatically disables the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"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 user manually disables it (returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER_INITIATED"},"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":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all possible codes and their descriptions."},"children":[]}]}]}],"enum":["CARD_ACCOUNT_CLOSED","INVALID_ACCOUNT_NUMBER","LOST_OR_STOLEN_CARD","NON_RELOADABLE_INSUFFICIENT_FUNDS","PICK_UP_CARD","RESTRICTED_CARD","USER_INITIATED"],"nullable":true},"disabled_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable message explaining why the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was disabled. This field provides additional context for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled_code"},"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 possible error codes/messages are:"},"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":"CARD_ACCOUNT_CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"The card account has been closed. The card has been disabled to prevent further use.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_ACCOUNT_NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"The card number is not valid. The card has been disabled to prevent further use.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LOST_OR_STOLEN_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"The card is reported lost or stolen. The card has been disabled to prevent further use.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NON_RELOADABLE_INSUFFICIENT_FUNDS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"The card has insufficient funds for the transaction and is non-reloadable. The card has been disabled to prevent further use.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PICK_UP_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"The card is reported lost or stolen. The card has been disabled to prevent further use.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESTRICTED_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"The card has a restriction preventing approval for this transaction. The card has been disabled to prevent further use.\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER_INITIATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"The card has been disabled by a user.\""},"children":[]}]}]}]}],"nullable":true},"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is enabled. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The user or the system can update this field to enable or disable the payment instrument."},"children":[]}]}]}]},"expiration_month":{"type":"integer","maximum":12,"minimum":1,"description":"Expiration month (e.g. 12 for December)."},"expiration_year":{"type":"integer","minimum":1,"description":"4-digit expiration year."},"fast_funds_indicator":{"type":"string","description":"Details if Fast Funds is enabled for the card."},"fingerprint":{"type":"string","example":"FPRxxxxxxxxxxxxxxxxx","description":"Unique ID that represents the tokenized card data."},"identity":{"$ref":"#/components/schemas/identity_id"},"instrument_type":{"type":"string","enum":["APPLE_PAY","GOOGLE_PAY","PAYMENT_CARD","PAYMENT_CARD_PRESENT","TOKEN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"issuer_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Alpha-3 Code of the country the card was issued in."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In addition, the following values are possible:"},"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":"NON_USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card was issued outside of the United States."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The processor did not return an issuer country for this particular BIN."},"children":[]}]}]}]}],"enum":["ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISL","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MOZ","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NON_USA","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","UNKNOWN","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","YEM","ZAF","ZMB","ZWE"]},"last_four":{"type":"string","description":"Last four digits of the card."},"name":{"type":"string","description":"The name of the card owner.","nullable":true},"network_token_enabled":{"$ref":"#/components/schemas/network_token_enabled_card"},"network_token_state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the network token. The possible enum values are as follows:"},"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":"NOT_ENABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"network_token_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_ENABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"network_token_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"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":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Immediately after Finix enables network tokens for a specific card, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"network_token_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is initially set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"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":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": After Finix receives the network token successfully from the card network, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"network_token_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updates to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"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":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": In the event that there is an issue with the card network such as service becomes unavailable, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": When the issuing bank does not allow the network token to be used in transactions, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUSPENDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": In the event that the issuing bank has closed the card permanently, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is returned."},"children":[]}]}]}]}],"enum":["ACTIVE","CLOSED","ENABLED","FAILED","NOT_ENABLED","SUSPENDED","PENDING"]},"payload_type":{"type":"string","enum":["SOURCE","DESTINATION"]},"online_gambing_block_indicator":{"type":"string","description":"Indicates whether the card is blocked from online gambling transactions.","nullable":true},"push_funds_block_indicator":{"type":"string","description":"Details if the card is enabled to receive push-to-card disbursements."},"name_verification_results":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details the results of verifying the cardholder's name with the issuing bank. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name_verification_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was not included in the request."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/name_verification_results"}]},"security_code_verification":{"type":"string","enum":["MATCHED","UNKNOWN","UNMATCHED"],"description":"Details the results of the Card Verification Code check."},"tags":{"$ref":"#/components/schemas/tags"},"third_party":{"type":"string","description":"This field is not applicable to payment cards.","nullable":true},"third_party_token":{"type":"string","description":"This field is not applicable to payment cards.","nullable":true},"type":{"type":"string","enum":["PAYMENT_CARD","TOKEN","GOOGLE_PAY","APPLE_PAY"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"application":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"authorizations":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created under the resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"identity":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}},"transfers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created under the resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"updates":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Updates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created under the resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"verifications":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}}}}}},"components/schemas/institution_number":{"id":"components/schemas/institution_number","kind":"json-schema","title":"institution_number","data":{"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":"Canadian bank identifier (EFT). Exactly 3 digits that identify the financial institution (e.g., 004 = TD, 002 = Scotiabank). Stored as a string to preserve leading zeros."},"children":[]}]}]}],"example":"004","minLength":3,"maxLength":3}},"components/schemas/transit_number":{"id":"components/schemas/transit_number","kind":"json-schema","title":"Transit Number","data":{"type":"string","nullable":true,"title":"Transit Number","description":"Canadian branch/branch-transit identifier (EFT). Exactly 5 digits that identify the branch where the account is held. Stored as a string to preserve leading zeros.\n","example":"12345","minLength":5,"maxLength":5}},"components/schemas/payment_instrument_bank":{"id":"components/schemas/payment_instrument_bank","kind":"json-schema","title":"Payment Instrument - Bank","data":{"type":"object","title":"Payment Instrument - Bank","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"created_via":{"$ref":"#/components/schemas/created_via"},"address":{"description":"The address of the bank account owner.","allOf":[{"$ref":"#/components/schemas/address"}]},"account_type":{"type":"string","enum":["CHECKING","BUSINESS_CHECKING","BUSINESS_SAVINGS","PERSONAL_CHECKING","PERSONAL_SAVINGS","SAVING"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bank account type. Plaid returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CHECKING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAVING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"application":{"$ref":"#/components/schemas/application_id"},"bank_account_validation_check":{"type":"string","enum":["INCONCLUSIVE","INVALID","NOT_ATTEMPTED","VALID"],"default":"NOT_ATTEMPTED","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attempt_bank_account_validation_check"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"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":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCONCLUSIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A verification check was conducted, but the bank account could not be found or verified with the issuing bank. Please contact the buyer to confirm the details collected or request an alternate method of payment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Payment Instrument was involved in transactions that returned one or more of the following ACH errors:"},"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":"Account Does Not Allow ACH Transactions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account is Closed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Account Funds are Frozen"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deceased Account Holder"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Account Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Invalid Routing Number"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No Account on File"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For further details about the different ACH failure codes, please refer to ACH Direct Debit documentation."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_ATTEMPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A verification check was not performed, and the Payment Instrument has not been used to create a Transfer or Authorization."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VALID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The bank account was successfully verified. The Payment Instrument is eligible for use in creating ACH Direct Debits."},"children":[]}]}]}]}]}]},"bank_code":{"type":"string","description":"The routing number of the bank account.","nullable":true},"country":{"$ref":"#/components/schemas/country"},"currency":{"$ref":"#/components/schemas/currency"},"disabled_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A code indicating why the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was disabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled_message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for possible error codes and their messages."},"children":[]}]}]}],"enum":["INVALID_BANK_ACCOUNT_ROUTING_NUMBER","MICRODEPOSIT_RETURNED","MICRODEPOSIT_VERIFICATION_REQUIRED","MICRODEPOSIT_VERIFICATION_ATTEMPTS_EXCEEDED","MICRODEPOSIT_VERIFICATION_EXPIRED","TOTAL_MICRODEPOSIT_ATTEMPTS_EXCEEDED_ACCOUNT_LOCKED","USER_INITIATED"],"nullable":true},"disabled_message":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable message explaining why the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was disabled. This field provides additional context for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disabled_code"},"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 possible error codes/messages are:"},"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":"INVALID_BANK_ACCOUNT_ROUTING_NUMBER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bank account routing number was invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MICRODEPOSIT_RETURNED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A microdeposit for this bank account was returned and the account has been disabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MICRODEPOSIT_VERIFICATION_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Bank account is pending microdeposit verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MICRODEPOSIT_VERIFICATION_ATTEMPTS_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Microdeposit verification has failed for this bank account. Please create a new bank account to try again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MICRODEPOSIT_VERIFICATION_EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The microdeposit verification window for this bank account has passed. Please create a new bank account to verify it again."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TOTAL_MICRODEPOSIT_ATTEMPTS_EXCEEDED_ACCOUNT_LOCKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": This bank account has reached the maximum number of microdeposit verification attempts and cannot be re-verified. This account is now locked."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER_INITIATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": \"The payment instrument has been disabled by a user.\""},"children":[]}]}]}]}],"nullable":true},"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is enabled. The default value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; set it to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"fingerprint":{"type":"string","description":"Unique ID that represents the tokenized bank account data."},"identity":{"$ref":"#/components/schemas/identity_id"},"institution_number":{"$ref":"#/components/schemas/institution_number"},"instrument_type":{"type":"string","enum":["BANK_ACCOUNT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"masked_account_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The last 4 digits of the account number used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"microdeposit":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the microdeposit sent to verify the bank account. Only returned when microdeposit verification is required. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/microdeposit-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Microdeposit Verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"example":"microdeposit_8cFbWq5n2KjXcVbtQkC1U1"},"microdeposit_verification_url":{"type":"string","description":"The URL of the hosted microdeposit verification page.","nullable":true},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the bank account. For Plaid-linked accounts, reflects the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" passed at creation if provided; otherwise defaults to the bank account name returned by Plaid."},"children":[]}]}]}],"nullable":true},"tags":{"$ref":"#/components/schemas/tags"},"third_party":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field identifies the external service used to connect the bank account."},"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":"PLAID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the account details are being sourced via Plaid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PLAID_RESELLER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the account details are being sourced via Plaid using Finix's Reseller flow."},"children":[]}]}]}]}],"enum":["PLAID","PLAID_RESELLER"],"nullable":true},"third_party_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Plaid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processor_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processor: finix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The token must have access to Plaid's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" products, which can be configured when creating the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://plaid.com/docs/auth/partnerships/finix/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaid's integration guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/plaid-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix's Plaid guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"example":"processor-sandbox-1487e3ec-fd86-40e2-b8d3-c8f260b4340c"},"transit_number":{"$ref":"#/components/schemas/transit_number"},"type":{"type":"string","enum":["BANK_ACCOUNT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"application":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"authorizations":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorizations"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created under the resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"identity":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}},"transfers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created under the resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"verifications":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}}}}}},"components/schemas/security_code":{"id":"components/schemas/security_code","kind":"json-schema","title":"security_code","data":{"type":"string","description":"The 3-or 4-digit security code for the card (i.e., the CVV code). While providing a CVV is optional, it is recommended to include it wherever possible to prevent fraud.\n","nullable":true}},"components/schemas/createPaymentInstrumentCard":{"id":"components/schemas/createPaymentInstrumentCard","kind":"json-schema","title":"Payment Instrument - Card","data":{"title":"Payment Instrument - Card","type":"object","properties":{"address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the card owner."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Including a postal or zip code when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can lower the interchange on credit card transactions."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/address"}]},"expiration_month":{"type":"integer","description":"The expiration month of the card (e.g. 12 for December)."},"expiration_year":{"type":"integer","description":"The 4-digit expiration year of the card."},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the card owner. This value can get truncated to comply with processor requirements."},"number":{"type":"string","description":"The card or bank account number (no dashes in between numbers)."},"security_code":{"$ref":"#/components/schemas/security_code"},"tags":{"$ref":"#/components/schemas/tags"},"third_party_token":{"type":"string","description":"Stringified token provided by Apple or Google. Required if using Apple or Google Pay."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PAYMENT_CARD"]}},"required":["expiration_month","expiration_year","identity","name","number","type"]}},"components/schemas/createPaymentInstrumentAccountUpdater":{"id":"components/schemas/createPaymentInstrumentAccountUpdater","kind":"json-schema","title":"Payment Instrument - Card - Enable Account Updater","data":{"title":"Payment Instrument - Card - Enable Account Updater","type":"object","properties":{"account_updater_enabled":{"$ref":"#/components/schemas/account_updater_enabled_card"},"address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the card owner."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Including a postal or zip code when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can lower the interchange on credit card transactions."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/address"}]},"expiration_month":{"type":"integer","description":"The expiration month of the card (e.g. 12 for December)."},"expiration_year":{"type":"integer","description":"The 4-digit expiration year of the card."},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the card owner. This value can get truncated to comply with processor requirements."},"number":{"type":"string","description":"The card or bank account number (no dashes in between numbers)."},"security_code":{"$ref":"#/components/schemas/security_code"},"tags":{"$ref":"#/components/schemas/tags"},"third_party_token":{"type":"string","description":"Stringified token provided by Apple or Google. Required if using Apple or Google Pay."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PAYMENT_CARD"]}},"required":["expiration_month","expiration_year","identity","name","number","type"]}},"components/schemas/createPaymentInstrumentNetworkTokens":{"id":"components/schemas/createPaymentInstrumentNetworkTokens","kind":"json-schema","title":"Payment Instrument - Card - Enable Network Tokens","data":{"title":"Payment Instrument - Card - Enable Network Tokens","type":"object","properties":{"address":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The address of the card owner."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Including a postal or zip code when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can lower the interchange on credit card transactions."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/address"}]},"expiration_month":{"type":"integer","description":"The expiration month of the card (e.g. 12 for December)."},"expiration_year":{"type":"integer","description":"The 4-digit expiration year of the card."},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the card owner. This value can get truncated to comply with processor requirements."},"network_token_enabled":{"$ref":"#/components/schemas/network_token_enabled_card"},"number":{"type":"string","description":"The card or bank account number (no dashes in between numbers)."},"security_code":{"$ref":"#/components/schemas/security_code"},"tags":{"$ref":"#/components/schemas/tags"},"third_party_token":{"type":"string","description":"Stringified token provided by Apple or Google. Required if using Apple or Google Pay."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PAYMENT_CARD"]}},"required":["expiration_month","expiration_year","identity","name","number","type"]}},"components/schemas/createPaymentInstrumentBankAccount":{"id":"components/schemas/createPaymentInstrumentBankAccount","kind":"json-schema","title":"Payment Instrument - Bank Account","data":{"title":"Payment Instrument - Bank Account","type":"object","properties":{"account_number":{"type":"string","description":"The bank account number (no dashes in between numbers).","minLength":5,"maxLength":17},"account_type":{"type":"string","enum":["BUSINESS_CHECKING","BUSINESS_SAVINGS","PERSONAL_CHECKING","PERSONAL_SAVINGS"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of bank account. Use the following respective enum when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL_CHECKING: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal checking account."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL_SAVINGS: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A personal savings account."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS_CHECKING: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A business checking account."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS_SAVINGS: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A business savings account."},"children":[]}]}]}]}]}]},"attempt_bank_account_validation_check":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify and validate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to ensure it is suitable for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/ach-direct-debits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Direct Debits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to confirm that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used for ACH payments."},"children":[]}]}]}],"default":false},"bank_code":{"type":"string","description":"The routing number of the bank account.","minLength":9,"maxLength":9,"example":"123456789"},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the bank account owner."},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","enum":["BANK_ACCOUNT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["account_number","account_type","bank_code","identity","type"]}},"components/schemas/createPaymentInstrumentPlaidBankAccount":{"id":"components/schemas/createPaymentInstrumentPlaidBankAccount","kind":"json-schema","title":"Payment Instrument - Plaid Bank Account","data":{"title":"Payment Instrument - Plaid Bank Account","type":"object","properties":{"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the account owner. Defaults to the bank account name returned by Plaid if not provided."},"third_party":{"type":"string","description":"A third-party service that allows for connecting to a bank account.","enum":["PLAID"]},"third_party_token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Plaid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processor_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"processor: finix"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The token must have access to Plaid's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" products, which can be configured when creating the Plaid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://plaid.com/docs/auth/partnerships/finix/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plaid's integration guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/plaid-integration"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix's Plaid guide"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type":{"type":"string","enum":["BANK_ACCOUNT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["third_party","third_party_token","identity","type"]}},"components/schemas/createPaymentInstrumentCanadianBankAccount":{"id":"components/schemas/createPaymentInstrumentCanadianBankAccount","kind":"json-schema","title":"Payment Instrument - Canadian Bank Account","data":{"title":"Payment Instrument - Canadian Bank Account","type":"object","properties":{"account_number":{"type":"string","description":"The bank account number (no dashes in between numbers). Canadian bank account numbers cannot exceed 15 characters."},"account_type":{"type":"string","description":"The type of bank account.\n","enum":["BUSINESS_CHECKING","BUSINESS_SAVINGS","PERSONAL_CHECKING","PERSONAL_SAVINGS"]},"country":{"type":"string","description":"The 3-letter country code.","enum":["CAN"]},"currency":{"type":"string","description":"The ISO 4217 3-letter currency code.","enum":["CAD"]},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"institution_number":{"$ref":"#/components/schemas/institution_number"},"name":{"type":"string","description":"The name of the bank account owner."},"tags":{"$ref":"#/components/schemas/tags"},"transit_number":{"$ref":"#/components/schemas/transit_number"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["BANK_ACCOUNT"]}},"required":["account_number","account_type","country","currency","identity","institution_number","transit_number","type"]}},"components/schemas/createPaymentInstrumentTokenCard":{"id":"components/schemas/createPaymentInstrumentTokenCard","kind":"json-schema","title":"Payment Instrument - Token - Card","data":{"title":"Payment Instrument - Token - Card","type":"object","properties":{"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the bank account or card owner. This value can get truncated to comply with processor requirements."},"tags":{"$ref":"#/components/schemas/tags"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was returned from the tokenization client or hosted fields"},"children":[]}]}]}]},"type":{"type":"string","enum":["TOKEN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["identity","token","type"]}},"components/schemas/createPaymentInstrumentTokenAccountUpdater":{"id":"components/schemas/createPaymentInstrumentTokenAccountUpdater","kind":"json-schema","title":"Payment Instrument - Token - Enable Account Updater","data":{"title":"Payment Instrument - Token - Enable Account Updater","type":"object","properties":{"account_updater_enabled":{"$ref":"#/components/schemas/account_updater_enabled_card"},"attempt_bank_account_validation_check":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify and validate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to confirm it can be used for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/ach-direct-debits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Direct Debits."},"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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used for ACH payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from bank accounts can be used for ACH payments."},"children":[]}]}]}]}]},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the bank account or card owner. This value can get truncated to comply with processor requirements."},"tags":{"$ref":"#/components/schemas/tags"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was returned from the tokenization client or hosted fields"},"children":[]}]}]}]},"type":{"type":"string","enum":["TOKEN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["identity","token","type"]}},"components/schemas/createPaymentInstrumentTokenBankAccount":{"id":"components/schemas/createPaymentInstrumentTokenBankAccount","kind":"json-schema","title":"Payment Instrument - Token - Bank Account","data":{"title":"Payment Instrument - Token - Bank Account","type":"object","properties":{"attempt_bank_account_validation_check":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify and validate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to confirm it can be used for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/ach-direct-debits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Direct Debits."},"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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used for ACH payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from bank accounts can be used for ACH payments."},"children":[]}]}]}]}]},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the bank account or card owner. This value can get truncated to comply with processor requirements."},"tags":{"$ref":"#/components/schemas/tags"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was returned from the tokenization client or hosted fields."},"children":[]}]}]}]},"type":{"type":"string","enum":["TOKEN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["identity","token","type"]}},"components/schemas/createPaymentInstrumentTokenNetworkTokens":{"id":"components/schemas/createPaymentInstrumentTokenNetworkTokens","kind":"json-schema","title":"Payment Instrument - Token - Enable Network Tokens","data":{"title":"Payment Instrument - Token - Enable Network Tokens","type":"object","properties":{"attempt_bank_account_validation_check":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verify and validate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to confirm it can be used for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/ach-direct-debits"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACH Direct Debits."},"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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"True"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be used for ACH payments."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instruments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from bank accounts can be used for ACH payments."},"children":[]}]}]}]}]},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the bank account or card owner. This value can get truncated to comply with processor requirements."},"network_token_enabled":{"$ref":"#/components/schemas/network_token_enabled_card"},"tags":{"$ref":"#/components/schemas/tags"},"token":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was returned from the tokenization client or hosted fields"},"children":[]}]}]}]},"type":{"type":"string","enum":["TOKEN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["identity","token","type"]}},"components/schemas/createPaymentInstrumentApplePay":{"id":"components/schemas/createPaymentInstrumentApplePay","kind":"json-schema","title":"Payment Instrument - Apple Pay","data":{"title":"Payment Instrument - Apple Pay","type":"object","properties":{"address":{"$ref":"#/components/schemas/address"},"identity":{"type":"string","description":[{"$$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":"Identity#id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer and owner of the card."},"children":[]}]}]}]},"merchant_identity":{"type":"string","description":[{"$$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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the identity used when registering the business with Apple Pay through our registration API."},"children":[]}]}]}]},"name":{"type":"string","description":[{"$$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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used when registering the seller with Apple Pay through our registration API."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"third_party_token":{"type":"string","description":"Stringified token provided by Apple. Required to process Apple Pay transactions."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["APPLE_PAY"]}},"required":["identity","merchant_identity","third_party_token","type"]}},"components/schemas/createPaymentInstrumentGooglePay":{"id":"components/schemas/createPaymentInstrumentGooglePay","kind":"json-schema","title":"Payment Instrument - Google Pay","data":{"title":"Payment Instrument - Google Pay","type":"object","properties":{"address":{"$ref":"#/components/schemas/address"},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"merchant_identity":{"type":"string","description":[{"$$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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the identity used when registering the business with Google Pay through our registration API."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the bank account or card owner. This value can get truncated to comply with processor requirements."},"tags":{"$ref":"#/components/schemas/tags"},"third_party_token":{"type":"string","description":"Stringified token provided by Google. Required to process Google Pay transactions."},"type":{"type":"string","enum":["GOOGLE_PAY"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["identity","merchant_identity","third_party_token","type"]}},"components/schemas/createPaymentInstrumentApplePayPassthrough":{"id":"components/schemas/createPaymentInstrumentApplePayPassthrough","kind":"json-schema","title":"Payment Instrument - Apple Pay - Passthrough","data":{"title":"Payment Instrument - Apple Pay - Passthrough","type":"object","properties":{"address":{"$ref":"#/components/schemas/address"},"cryptogram":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wallet-generated cryptogram from the decrypted Apple Pay token. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"number"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided."},"children":[]}]}]}]},"electronic_commerce_indicator_code":{"type":"string","description":"One-or-two-digit value indicating the authentication method used. The card network and issuer factor this into liability and risk decisions on the authorization."},"expiration_month":{"type":"integer","description":"Card expiration month (1-12)."},"expiration_year":{"type":"integer","description":"Card expiration year (4-digit)."},"identity":{"type":"string","description":[{"$$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":"Identity#id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer and owner of the card."},"children":[]}]}]}]},"merchant_identity":{"type":"string","description":[{"$$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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the identity used when registering the business with Apple Pay through our registration API."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the card owner."},"number":{"type":"string","description":"Network token PAN (DPAN) from the decrypted Apple Pay token."},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["APPLE_PAY"]}},"required":["cryptogram","identity","merchant_identity","number","type"]}},"components/schemas/createPaymentInstrumentGooglePayPassthrough":{"id":"components/schemas/createPaymentInstrumentGooglePayPassthrough","kind":"json-schema","title":"Payment Instrument - Google Pay - Passthrough","data":{"title":"Payment Instrument - Google Pay - Passthrough","type":"object","properties":{"address":{"$ref":"#/components/schemas/address"},"cryptogram":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Wallet-generated cryptogram from the decrypted Google Pay token. Not required for PAN_ONLY tokens, which do not produce a cryptogram."},"children":[]}]}]}]},"electronic_commerce_indicator_code":{"type":"string","description":"One-or-two-digit value indicating the authentication method used. The card network and issuer factor this into liability and risk decisions on the authorization."},"expiration_month":{"type":"integer","description":"Card expiration month (1-12)."},"expiration_year":{"type":"integer","description":"Card expiration year (4-digit)."},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"merchant_identity":{"type":"string","description":[{"$$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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the identity used when registering the business with Google Pay through our registration API."},"children":[]}]}]}]},"name":{"type":"string","description":"The name of the bank account or card owner. This value can get truncated to comply with processor requirements."},"number":{"type":"string","description":"Network token PAN (DPAN) from the decrypted Google Pay token. May be a raw PAN for Google Pay."},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","enum":["GOOGLE_PAY"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["identity","merchant_identity","number","type"]}},"components/schemas/updatePaymentInstrumentDisable":{"id":"components/schemas/updatePaymentInstrumentDisable","kind":"json-schema","title":"Payment Instrument - Disable a Payment Instrument","data":{"title":"Payment Instrument - Disable a Payment Instrument","type":"object","properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is enabled. Default value is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/updatePaymentInstrumentAccountUpdater":{"id":"components/schemas/updatePaymentInstrumentAccountUpdater","kind":"json-schema","title":"Payment Instrument - Enable Account Updater","data":{"title":"Payment Instrument - Enable Account Updater","type":"object","properties":{"account_updater_enabled":{"$ref":"#/components/schemas/account_updater_enabled_card"}}}},"components/schemas/updatePaymentInstrumentNetworkTokens":{"id":"components/schemas/updatePaymentInstrumentNetworkTokens","kind":"json-schema","title":"Payment Instrument - Enable Network Tokens","data":{"title":"Payment Instrument - Enable Network Tokens","type":"object","properties":{"network_token_enabled":{"$ref":"#/components/schemas/network_token_enabled_card"}}}},"components/schemas/updatePaymentInstrumentCardAddress":{"id":"components/schemas/updatePaymentInstrumentCardAddress","kind":"json-schema","title":"Payment Instrument - Update Card Address","data":{"title":"Payment Instrument - Update Card Address","type":"object","properties":{"address":{"$ref":"#/components/schemas/address"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"verify_payment_card":{"type":"boolean","description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify the updated billing address with the card issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be included with your request."},"children":[]}]}]}]}],"default":false}},"required":["address","merchant","verify_payment_card"]}},"components/schemas/updatePaymentInstrumentName":{"id":"components/schemas/updatePaymentInstrumentName","kind":"json-schema","title":"Payment Instrument - Update Name","data":{"title":"Payment Instrument - Update Name","type":"object","properties":{"name":{"type":"string","description":"The name of the card owner. This value can get truncated to comply with processor requirements."}},"required":["name"]}},"components/schemas/updatePaymentInstrumentNameAndVerify":{"id":"components/schemas/updatePaymentInstrumentNameAndVerify","kind":"json-schema","title":"Payment Instrument - Update and Verify Name","data":{"type":"object","title":"Payment Instrument - Update and Verify Name","properties":{"merchant":{"type":"string","description":[{"$$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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"Must be included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verify_payment_card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"name_verification_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder name details to verify against the card issuer. Only supported on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated by concatenating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"middle_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"first_name":{"type":"string","description":"The cardholder's first name."},"last_name":{"type":"string","description":"The cardholder's last name."},"middle_name":{"type":"string","description":"The cardholder's middle name."}},"required":["first_name","last_name"]},"verify_payment_card":{"type":"boolean","description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify card details with the card issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be included with your request."},"children":[]}]}]}]}]}},"required":["merchant","name_verification_details","verify_payment_card"]}},"components/schemas/updatePaymentInstrumentTags":{"id":"components/schemas/updatePaymentInstrumentTags","kind":"json-schema","title":"Payment Instrument - Update Tags","data":{"title":"Payment Instrument - Update Tags","type":"object","properties":{"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updatePaymentInstrumentAddressGoogleApplePay":{"id":"components/schemas/updatePaymentInstrumentAddressGoogleApplePay","kind":"json-schema","title":"Payment Instrument - Add Address for Google or Apple Pay","data":{"title":"Payment Instrument - Add Address for Google or Apple Pay","type":"object","properties":{"address":{"$ref":"#/components/schemas/address"}},"required":["address"]}},"components/schemas/updatePaymentInstrumentExpiration":{"id":"components/schemas/updatePaymentInstrumentExpiration","kind":"json-schema","title":"Payment Instrument - Update Expiration Date","data":{"title":"Payment Instrument - Update Expiration Date","type":"object","properties":{"expiration_month":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiration month of the payment card. Must be between 1 and 12. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided together."},"children":[]}]}]}]},"expiration_year":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiration year of the payment card. Must be a 4-digit year equal to or greater than the current year. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expiration_year"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided together."},"children":[]}]}]}]}},"required":["expiration_month","expiration_year"]}},"components/schemas/updatePaymentInstrumentVerifyMicroDeposits":{"id":"components/schemas/updatePaymentInstrumentVerifyMicroDeposits","kind":"json-schema","title":"Payment Instrument - Verify Microdeposits","data":{"title":"Payment Instrument - Verify Microdeposits","type":"object","properties":{"verification_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The verification code from the $0.01 microdeposit's bank statement descriptor. Matching is case-insensitive, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FNX"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" prefix is optional."},"children":[]}]}]}],"example":"FNX7Q2M"},"verify_microdeposits":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to submit the request as a microdeposit verification. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/bank-payments/microdeposit-verification"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Microdeposit Verification"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["verification_code","verify_microdeposits"]}},"components/schemas/instrument_history_entry":{"id":"components/schemas/instrument_history_entry","kind":"json-schema","title":"instrument_history_entry","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"created_at":{"$ref":"#/components/schemas/created_at"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A label indicating the type of update applied to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The following enums are possible:"},"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":"CONTACT_CARDHOLDER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The cardholder has opted out of the service. Please get in touch with the cardholder to acquire up-to-date card information."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FRAUD_REPORTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Fraud was reported by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"code","inline":true,"attributes":{"content":"NUMBER_AND_EXPIRATION_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Both the card number and expiry date changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NUMBER_UPDATED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The card number has changed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The issuing bank does not participate in account updater. This enumerator will only be returned once."},"children":[]}]}]}]}],"enum":["CONTACT_CARDHOLDER","FRAUD_REPORTED","NOT_FOUND","NUMBER_AND_EXPIRATION_UPDATED","NUMBER_UPDATED"]},"application_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created, resulting in this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payment_instrument_id":{"type":"string","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that triggered the creation of this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"payment_instrument_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that triggered this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PAYMENT_CARD"]},"old_instrument_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details prior to the card update."},"children":[]}]}]}],"properties":{"bin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Bank Identification Number for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"brand":{"type":"string","enum":["UNKNOWN","DINERS_CLUB_INTERNATIONAL","DANKORT","MIR","TROY","UATP","CHINA_T_UNION","CHINA_UNION_PAY","AMERICAN_EXPRESS","VERVE","RUPAY","DISCOVER","JCB","MASTERCARD","INTERPAYMENT","INSTAPAYMENT","MAESTRO","VISA","LANKAPAY","DINERS_CLUB","INTERAC"],"description":[{"$$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":"brand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the card saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"expiration_month":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiration month of the card (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for December)."},"children":[]}]}]}]},"expiration_year":{"type":"integer","description":"The 4-digit expiration year of the card."},"last_four":{"type":"string","description":"The last four digits of the card."},"fingerprint":{"type":"string","example":"FPRxxxxxxxxxxxxxxxxx","description":"Unique ID that represents the tokenized card data."}}},"new_instrument_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details after the card update."},"children":[]}]}]}],"properties":{"bin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Bank Identification Number for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"brand":{"type":"string","enum":["UNKNOWN","DINERS_CLUB_INTERNATIONAL","DANKORT","MIR","TROY","UATP","CHINA_T_UNION","CHINA_UNION_PAY","AMERICAN_EXPRESS","VERVE","RUPAY","DISCOVER","JCB","MASTERCARD","INTERPAYMENT","INSTAPAYMENT","MAESTRO","VISA","LANKAPAY","DINERS_CLUB","INTERAC"],"description":[{"$$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":"brand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the card saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"expiration_month":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expiration month of the card (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for December)."},"children":[]}]}]}]},"expiration_year":{"type":"integer","description":"The 4-digit expiration year of the card."},"last_four":{"type":"string","description":"The last four digits of the card."},"fingerprint":{"type":"string","example":"FPRxxxxxxxxxxxxxxxxx","description":"Unique ID that represents the tokenized card data."}}},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Instrument History Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]}}}}}}}},"components/schemas/updatePaymentInstrumentVerificationCVV":{"id":"components/schemas/updatePaymentInstrumentVerificationCVV","kind":"json-schema","title":"CVV Verification","data":{"type":"object","title":"CVV Verification","properties":{"merchant":{"type":"string","description":[{"$$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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"Must be included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verify_payment_card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"security_code":{"$ref":"#/components/schemas/security_code"},"verify_payment_card":{"type":"boolean","description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify card details with the card issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update the CVV or security code of a card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be included with your request."},"children":[]}]}]}]}]}},"required":["merchant","security_code","verify_payment_card"]}},"components/schemas/updatePaymentInstrumentVerificationAddress":{"id":"components/schemas/updatePaymentInstrumentVerificationAddress","kind":"json-schema","title":"Address Verification","data":{"type":"object","title":"Address Verification","properties":{"address":{"$ref":"#/components/schemas/address"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"verify_payment_card":{"type":"boolean","description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify the cardholder's address with the card issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be included with your request."},"children":[]}]}]}]}]}},"required":["address","merchant","verify_payment_card"]}},"components/schemas/updatePaymentInstrumentVerificationName":{"id":"components/schemas/updatePaymentInstrumentVerificationName","kind":"json-schema","title":"Name Verification","data":{"type":"object","title":"Name Verification","properties":{"merchant":{"type":"string","description":[{"$$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 ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"Must be included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"verify_payment_card"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"name_verification_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cardholder name details to verify against the card issuer. Only supported on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"tag","tag":"admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated by concatenating "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"middle_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"properties":{"first_name":{"type":"string","description":"The cardholder's first name."},"last_name":{"type":"string","description":"The cardholder's last name."},"middle_name":{"type":"string","description":"The cardholder's middle name."}},"required":["first_name","last_name"]},"verify_payment_card":{"type":"boolean","description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to verify card details with the card issuer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When set to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"true"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be included with your request."},"children":[]}]}]}]}]}},"required":["merchant","name_verification_details","verify_payment_card"]}},"components/schemas/createPaymentInstrumentVerificationPushToCard":{"id":"components/schemas/createPaymentInstrumentVerificationPushToCard","kind":"json-schema","title":"Push-to-Card Eligibility","data":{"type":"object","title":"Push-to-Card Eligibility","properties":{"processor":{"type":"string","enum":["DUMMY_V1","FINIX_V1"],"default":"DUMMY_V1","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The acquiring processor. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUMMY_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use your sandbox. For more details on which processor to use, reach out to your Finix point of contact or email "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/getting-started/support-at-finix/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix Support"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["processor"]}},"components/schemas/payment_instrument_verification":{"id":"components/schemas/payment_instrument_verification","kind":"json-schema","title":"Payment Instrument Verification","data":{"type":"object","title":"Payment Instrument Verification","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"type":"string","$ref":"#/components/schemas/application_id"},"identity":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"merchant":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"merchant_identity":{"type":"string","description":"This field is not applicable to payment instrument verification.","nullable":true,"default":null},"messages":{"type":"array","description":"A codified list of reasons the verification request failed.","items":{"type":"string"},"default":[]},"outcome_summary":{"type":"string","description":"A message providing additional context about why the verification request failed.","nullable":true,"default":null},"outcomes":{"type":"array","description":"A codified list of reasons the verification request failed.","items":{"type":"object"},"nullable":true,"default":null},"payment_instrument":{"type":"string","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent for verification."},"children":[]}]}]}],"default":null},"payment_instrument_verification_details":{"type":"object","description":"The payment instruction verification results.","properties":{"pull_from_card_cross_border":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supports pull-from-card, cross-border.  For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/card-payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push to Card"},"children":[]}]}]}]}],"enum":["FAST_FUNDS","NON_FAST_FUNDS","NOT_SUPPORTED","UNKNOWN"],"nullable":true,"default":null},"pull_from_card_domestic":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supports pull-from-card, domestically.  For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/card-payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push to Card"},"children":[]}]}]}]}],"enum":["FAST_FUNDS","NON_FAST_FUNDS","NOT_SUPPORTED","UNKNOWN"],"nullable":true,"default":null},"push_to_card_domestic":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supports push-to-card, domestically. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/card-payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push to Card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["FAST_FUNDS","NON_FAST_FUNDS","NOT_SUPPORTED","UNKNOWN"],"nullable":true,"default":null},"push_to_card_cross_border":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supports push-to-card, cross-border. For more details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/card-payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Push to Card"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["FAST_FUNDS","NON_FAST_FUNDS","NOT_SUPPORTED","UNKNOWN"],"nullable":true,"default":null},"card_type":{"type":"string","description":"A code that indicates whether the card is credit, debit, or prepaid.","enum":["CREDIT","DEBIT","HSA_FSA","RELOADABLE_PREPAID","UNRELOADABLE_PREPAID","UNKNOWN"],"nullable":true,"default":null},"billing_currency":{"type":"string","description":"The currency in which the payment instrument's holder is billed or charged.","nullable":true,"default":null},"issuer_country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country where the entity (bank or financial institution) that issued the payment instrument (e.g., credit card, debit card) is located."},"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":"NON_USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card was issued outside of the United States."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The card was issued in the United States."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNKNOWN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The processor did not return an issuer country for this particular BIN."},"children":[]}]}]}]}],"enum":["NON_USA","USA","UNKNOWN"],"nullable":true,"default":null},"name_verification_results":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details the results of verifying the cardholder's name with the issuing bank. Only returned for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type verifications on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VISA_V1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" processors."},"children":[]}]}]}],"type":"object","nullable":true,"default":null,"properties":{"first_name":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's first name."},"last_name":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's last name."},"middle_name":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's middle name."},"name":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's full name."},"first_name_verification":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's first name."},"last_name_verification":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's last name."},"middle_name_verification":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's middle name."},"name_verification":{"type":"string","enum":["MATCH","MATCHED","NO_MATCH","NOT_SUPPORTED","PARTIAL_MATCH","UNKNOWN"],"description":"The result of verifying the cardholder's full name."}}}}},"processor":{"type":"string","description":"Name of the verification processor.","enum":["FINIX_V1","DUMMY_V1"]},"raw":{"$ref":"#/components/schemas/raw"},"reverification_reason":{"type":"object","description":"The reason the payment instrument was re-verified.","nullable":true,"properties":{"initiated_by":{"type":"string","description":"The initiator of the re-verification.","nullable":true},"reason_description":{"type":"string","description":"A description of the reason for re-verification.","nullable":true},"review_type":{"type":"string","description":"The type of review.","nullable":true}}},"state":{"type":"string","description":"The state of the payment instrument verification request.","enum":["PENDING","FAILED","SUCCEEDED"]},"sub_type":{"type":"string","description":"The sub-type of the verification.","nullable":true},"tags":{"$ref":"#/components/schemas/tags"},"trace_id":{"type":"string","description":"An ID used for tracking the verification request."},"type":{"type":"string","description":"Details the type of resource getting verified.","enum":["PAYMENT_INSTRUMENT"]},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"self":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Verification"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"application":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with this resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"payment_instrument":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent for verification."},"children":[]}]}]}],"properties":{"href":{"type":"string","minLength":1}}}}}}}},"components/schemas/payment_instrument_association":{"id":"components/schemas/payment_instrument_association","kind":"json-schema","title":"Payment Instrument Association","data":{"title":"Payment Instrument Association","type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"instrument_association_9xZ6pUo5fXb7aAB4o3TqkK"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the resource was created under."},"children":[]}]}]}],"example":"APxxx"},"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether this current "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled."},"children":[]}]}]}]},"payment_instrument_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whose events will be charged to the specified merchant."},"children":[]}]}]}],"example":"PIcgYZswyRfqSSbvMsxuaHxZ"},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that fees will be applied to."},"children":[]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"}}}}}},"components/schemas/createPaymentInstrumentAssociation":{"id":"components/schemas/createPaymentInstrumentAssociation","kind":"json-schema","title":"createPaymentInstrumentAssociation","data":{"type":"object","required":["merchant_id","payment_instrument_id"],"properties":{"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that fees will be applied to."},"children":[]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"payment_instrument_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" whose events will be charged to the specified merchant."},"children":[]}]}]}],"example":"PIcgYZswyRfqSSbvMsxuaHxZ"},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updatePaymentInstrumentAssociation":{"id":"components/schemas/updatePaymentInstrumentAssociation","kind":"json-schema","title":"Update Payment Instrument Association - Tags","data":{"type":"object","title":"Update Payment Instrument Association - Tags","properties":{"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updatePaymentInstrumentAssociationDisabled":{"id":"components/schemas/updatePaymentInstrumentAssociationDisabled","kind":"json-schema","title":"Update Payment Instrument Association - Disable","data":{"title":"Update Payment Instrument Association - Disable","type":"object","properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to false if you wish to disable this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument Association"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/receipt_requested_delivery_methods":{"id":"components/schemas/receipt_requested_delivery_methods","kind":"json-schema","title":"receipt_requested_delivery_methods","data":{"type":"array","description":"A list of requested delivery methods. Each method specifies\nthe type of delivery and the destination(s) where the receipt should be sent.\n","items":{"type":"object","required":["type","destinations"],"properties":{"type":{"type":"string","description":"The method of receipt delivery.\n","enum":["EMAIL","SMS","PRINT"]},"destinations":{"type":"array","description":"A list of destination addresses or identifiers where the receipt should be sent.\n","items":{"type":"string"},"minItems":1}}}}},"components/schemas/createReceiptMinimalFields":{"id":"components/schemas/createReceiptMinimalFields","kind":"json-schema","title":"Receipt - Minimal Fields","data":{"title":"Receipt - Minimal Fields","type":"object","properties":{"entity_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for which the receipt must be generated."},"children":[]}]}]}]},"requested_delivery_methods":{"$ref":"#/components/schemas/receipt_requested_delivery_methods"},"send_receipt_to_buyer":{"type":"boolean","description":"Whether to send a receipt to the buyer."}},"required":["entity_id","send_receipt_to_buyer"]}},"components/schemas/subtotal_amount":{"id":"components/schemas/subtotal_amount","kind":"json-schema","title":"subtotal_amount","data":{"type":"integer","format":"int32","description":"The subtotal amount, in cents. This value reflects the total of all\nline items before applying any discounts, taxes, shipping fees, or other\nadditional charges.\n"}},"components/schemas/customization_details":{"id":"components/schemas/customization_details","kind":"json-schema","title":"customization_details","data":{"type":"object","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom attributes and free-form text sections to display on the PDF receipt."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customization_details.subheader_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Passing both in the request results in an error."},"children":[]}]}]}],"properties":{"footer_sections":{"type":"array","description":"Free-text sections displayed below the line items of the PDF receipt. For example, you can include a custom footer.","default":[],"maxItems":5,"items":{"type":"object","description":"Free-text sections displayed below the line items of the PDF receipt.","properties":{"name":{"type":"string","description":"The heading of a free-text section displayed below the line items of the PDF receipt.","maxLength":200,"example":"Return Policy"},"value":{"type":"string","description":"The body of a free-text section displayed below the line items of the PDF receipt.","maxLength":2000,"example":"30-day return window with receipt. No refunds on clearance items. Exchanges allowed within 14 days."}},"required":["name","value"]}},"subheader_attributes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fields shown near the top of the PDF, such as an invoice number or order ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customization_details.subheader_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Passing both in the request results in an error."},"children":[]}]}]}],"maxItems":5,"default":[],"items":{"type":"object","description":"Key-value pairs shown near the top of the PDF.","properties":{"name":{"type":"string","description":"The attribute name shown near the top of the PDF. This should be a short, human-readable identifier such as \"Invoice Number\", \"VIN\", \"Service Date\", or \"Technician\".","maxLength":25,"example":"PO Number"},"value":{"type":"string","description":"The corresponding value for the attribute shown near the top of the PDF. This can be any string that provides relevant context or information, such as an invoice number, vehicle identification number, or date.","maxLength":25,"example":"PO-12345"}},"required":["name","value"]}},"summary_sections":{"type":"array","description":"Free-text sections displayed above the line items of the PDF receipt, such as payment instructions.\n","default":[],"maxItems":5,"items":{"type":"object","description":"Free-text sections displayed above the line items of the PDF receipt.","properties":{"name":{"type":"string","description":"The heading of a free-text section displayed above the line items of the PDF receipt.","maxLength":200,"example":"Payment Instructions"},"value":{"type":"string","description":"The body of a free-text section displayed above the line items of the PDF receipt.","maxLength":2000,"example":"Make a payment using our online portal."}},"required":["name","value"]}}}}},"components/schemas/createReceipt":{"id":"components/schemas/createReceipt","kind":"json-schema","title":"Receipt - All Fields","data":{"type":"object","title":"Receipt - All Fields","properties":{"additional_details":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of key-value pairs for including metadata or custom information related to the receipt. Each entry must contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additional_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customization_details.subheader_attributes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Passing both in the request results in an error."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The label or title for the additional detail. This should be a short, human-readable identifier such as \"Invoice Number\", \"VIN\", \"Service Date\", or \"Technician\".","maxLength":25,"example":"Invoice Number"},"value":{"type":"string","description":"The corresponding value for the detail. This can be any string that provides relevant context or information, such as an invoice number, vehicle identification number, or date.","maxLength":25,"example":"4FEBVZP0-0002"}},"required":["name","value"]}},"amount_breakdown":{"type":"object","description":"The individual charges/fees that add up to the total amount.","properties":{"additional_buyer_charges":{"description":"Additional charges that the buyer paid.","allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"discount_amount":{"type":"integer","description":"A reduction applied to the total amount."},"estimated_tax_amount":{"type":"integer","description":"The estimated amount of tax applied to the order."},"shipping_amount":{"type":"integer","description":"The amount charged for shipping the items in the order."},"subtotal_amount":{"$ref":"#/components/schemas/subtotal_amount"},"tip_amount":{"type":"integer","description":"The tip amount included in the order total."}}},"customization_details":{"$ref":"#/components/schemas/customization_details"},"entity_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for which the receipt must be generated."},"children":[]}]}]}]},"items":{"$ref":"#/components/schemas/items"},"requested_delivery_methods":{"type":"array","description":"An array of delivery methods used to send the receipt.","items":{"type":"object","description":"An individual delivery method.","required":["type","destinations"],"properties":{"destinations":{"type":"array","description":"A list of destinations to send the receipt.","items":{"type":"string","description":"A destination to send the receipt."}},"type":{"type":"string","description":"The type of delivery method used to send the receipt.","enum":["EMAIL","PRINT","SMS"]}}}},"send_receipt_to_buyer":{"type":"boolean","description":"Whether to send a receipt to the buyer."}},"required":["entity_id","send_receipt_to_buyer"]}},"components/schemas/operation_key":{"id":"components/schemas/operation_key","kind":"json-schema","title":"operation_key","data":{"description":"Details the operation that's performed in the transaction.","type":"string","enum":["PUSH_TO_CARD","PULL_FROM_CARD","CARD_PRESENT_SALE","CARD_PRESENT_UNREFERENCED_REFUND","CARD_NOT_PRESENT_SALE","CARD_NOT_PRESENT_CAPTURE","SALE","UNREFERENCED_REFUND","MERCHANT_CREDIT_ADJUSTMENT","MERCHANT_DEBIT_ADJUSTMENT"],"nullable":true}},"components/schemas/receipt":{"id":"components/schemas/receipt","kind":"json-schema","title":"receipt","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"additional_details":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of key-value pairs for including metadata or custom information related to the receipt. Each entry must contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as strings."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The label or title for the additional detail. This should be a short, human-readable identifier such as \"Invoice Number\", \"VIN\", \"Service Date\", or \"Technician\".","maxLength":25,"example":"Invoice Number"},"value":{"type":"string","description":"The corresponding value for the detail. This can be any string that provides relevant context or information, such as an invoice number, vehicle identification number, or date.","maxLength":25,"example":"4FEBVZP0-0002"}},"required":["name","value"]}},"amount":{"$ref":"#/components/schemas/amount"},"application_id":{"$ref":"#/components/schemas/application_id"},"currency":{"$ref":"#/components/schemas/currency"},"amount_breakdown":{"type":"object","description":"The individual charges/fees that add up to the total amount.","nullable":true,"properties":{"subtotal_amount":{"$ref":"#/components/schemas/subtotal_amount"},"discount_amount":{"type":"integer","description":"A reduction applied to the total amount.","nullable":true},"shipping_amount":{"type":"integer","description":"The amount charged for shipping the items in the order.","nullable":true},"estimated_tax_amount":{"type":"integer","description":"The estimated amount of tax applied to the order.","nullable":true},"tip_amount":{"type":"integer","description":"The tip amount included in the order total.","nullable":true},"additional_buyer_charges":{"description":"Additional charges that the buyer paid.","allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"customs_duty_amount":{"type":"integer","description":"The amount charged for customs duties.","nullable":true}}},"customization_details":{"$ref":"#/components/schemas/customization_details"},"send_receipt_to_buyer":{"type":"boolean","description":"Whether to send a receipt to the buyer."},"device_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/in-person-payments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"in-person payments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The ID of the Point-of-Sale terminal used to process the payment."},"children":[]}]}]}],"nullable":true},"entity_details":{"type":"object","description":[{"$$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":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details from which to generate the receipt."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"created_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created."},"children":[]}]}]}]},"operation_key":{"$ref":"#/components/schemas/operation_key"},"type":{"type":"string","description":"The type of transaction the receipt was created for.","enum":["TRANSFER","AUTHORIZATION"]}}},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of receipt, either for the customer ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUYER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or the merchant ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MERCHANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for a CP (card-present) transaction. For a CNP transaction, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BUYER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["BUYER","MERCHANT"]},"items":{"$ref":"#/components/schemas/items"},"merchant_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"business_name":{"type":"string","minLength":1,"maxLength":120,"description":"The merchant's legal business name. For a sole proprietorship, pass the owner's legal first name, last name, and middle initial.\n","nullable":true},"doing_business_as":{"type":"string","minLength":1,"maxLength":60,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"business_address":{"type":"object","description":"The primary address for the legal entity.","nullable":true,"properties":{"city":{"type":"string","minLength":1,"maxLength":20,"description":"City.","nullable":true},"country":{"$ref":"#/components/schemas/country"},"line1":{"type":"string","minLength":1,"maxLength":35,"description":"The first line of the address.","nullable":true},"line2":{"type":"string","minLength":1,"maxLength":35,"description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","minLength":1,"maxLength":7,"description":"The zip or postal code.","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true}}}}},"payment_instrument_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" details."},"children":[]}]}]}],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PAYMENT_CARD"]},"billing_address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The primary address associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"city":{"type":"string","minLength":1,"maxLength":20,"description":"City.","nullable":true},"country":{"$ref":"#/components/schemas/country"},"line1":{"type":"string","minLength":1,"maxLength":35,"description":"The first line of the address.","nullable":true},"line2":{"type":"string","minLength":1,"maxLength":35,"description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","minLength":1,"maxLength":7,"description":"The zip or postal code.","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true}}},"bin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Bank Identification Number for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"brand":{"type":"string","enum":["UNKNOWN","DINERS_CLUB_INTERNATIONAL","DANKORT","MIR","TROY","UATP","CHINA_T_UNION","CHINA_UNION_PAY","AMERICAN_EXPRESS","VERVE","RUPAY","DISCOVER","JCB","MASTERCARD","INTERPAYMENT","INSTAPAYMENT","MAESTRO","VISA","LANKAPAY","DINERS_CLUB","INTERAC"],"description":[{"$$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":"brand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the card saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"card_type":{"type":"string","enum":["CREDIT","DEBIT","HSA_FSA","NON_RELOADABLE_PREPAID","RELOADABLE_PREPAID","UNKNOWN"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of payment card saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"last_four":{"type":"string","description":"The last four digits of the card or bank account number."},"name":{"type":"string","description":"The name of the bank account or card owner.","nullable":true}}},"network_details":{"type":"object","description":"An object containing EMV data.","nullable":true,"properties":{"application_label":{"type":"string","description":"The EMV application label. Tag 50 from the EMVCo standard.","nullable":true},"application_identifier":{"type":"string","description":"The ID of the application used in the transaction. Tag 9F06 from the EMVCo standard.","nullable":true},"cryptogram":{"type":"string","description":"The cryptogram returned by the card. Tag 9F26 of the EMVCo standard.","nullable":true},"approval_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique ID used to identify the approval of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}}},"requested_delivery_methods":{"type":"array","default":[],"description":"An array of delivery methods used to send the receipt.","items":{"type":"object","description":"An individual delivery method.","required":["type","destinations"],"properties":{"type":{"type":"string","description":"The type of delivery method used to send the receipt.","enum":["EMAIL","SMS","PRINT"]},"destinations":{"type":"array","description":"A list of destinations to send the receipt.","items":{"type":"string","description":"A destination to send the receipt."}}}}},"receipt_url":{"type":"string","description":"The location of the receipt on Finix's Amazon S3."},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"The path to the new resource."}}}}}}}},"components/schemas/receipt_delivery_attempt":{"id":"components/schemas/receipt_delivery_attempt","kind":"json-schema","title":"receipt_delivery_attempt","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"destination":{"type":"string","description":"The receipt delivery attempt destination."},"receipt_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Receipt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Delivery Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"state":{"type":"string","description":"Whether the delivery attempt succeeded or failed.","enum":["SUCCEEDED","FAILED"]},"type":{"type":"string","description":"The type of delivery method used to send the receipt.","enum":["EMAIL","SMS","PRINT"]}}}},"components/schemas/createReceiptDeliveryAttempt":{"id":"components/schemas/createReceiptDeliveryAttempt","kind":"json-schema","title":"createReceiptDeliveryAttempt","data":{"type":"object","properties":{"requested_delivery_methods":{"type":"array","description":"A list of delivery methods used to send the receipt.","items":{"type":"object","description":"An individual delivery method.","required":["type","destinations"],"properties":{"destinations":{"type":"array","description":"A list of destinations to send the receipt.","items":{"type":"string","description":"A destination to send the receipt."}},"type":{"type":"string","description":"The type of delivery method used to send the receipt.","enum":["EMAIL","PRINT","SMS"]}}}}},"required":["requested_delivery_methods"]}},"components/schemas/Settlement":{"id":"components/schemas/Settlement","kind":"json-schema","title":"Settlement","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"$ref":"#/components/schemas/application_id"},"currency":{"$ref":"#/components/schemas/currency"},"destination":{"type":"string","example":"PIxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where funds will be sent."},"children":[]}]}]}],"nullable":true},"funds_flow":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details how funds will be dispersed in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (usually "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"nullable":true},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"is_exception":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains items that were removed from a previous "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"net_amount":{"type":"integer","description":"The amount in cents that will be deposited into the merchant's bank account."},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (or the original payment)."},"children":[]}]}]}],"nullable":true},"payout_profile_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was used to generate the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"processor":{"type":"string","description":"The name of the processor."},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Merchants only receive payouts when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payouts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["APPROVED","AWAITING_APPROVAL"]},"tags":{"$ref":"#/components/schemas/tags"},"total_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in cents."},"children":[]}]}]}]},"total_fee":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sum of the fees in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"total_fees":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The sum of the fees in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including subscription billing fees."},"children":[]}]}]}]},"window_end_time":{"type":"string","format":"date-time","description":"The end of the settlement window period.","nullable":true},"window_start_time":{"type":"string","format":"date-time","description":"The start of the settlement window period.","nullable":true},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":false,"enum":["MERCHANT_REVENUE","PLATFORM_FEE","PARTNER_FEE","NOOP","MERCHANT","APPLICATION","PLATFORM"]},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"application":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the resource was created under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"credits":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the credits associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"debits":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the debits associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"disputes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"fees":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"funding_transfers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the settlement funding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"identity":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the resource was created under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"reversals":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the reversals associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}},"transfers":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the transfers associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}}}}}},"components/schemas/closeSettlement":{"id":"components/schemas/closeSettlement","kind":"json-schema","title":"closeSettlement","data":{"type":"object","properties":{"action":{"type":"string","enum":["STOP_ACCRUAL"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action you want to perform on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STOP_ACCRUAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to close the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["action"]}},"components/schemas/SettlementEntry":{"id":"components/schemas/SettlementEntry","kind":"json-schema","title":"SettlementEntry","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An entry is an object that describes an item inside of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"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 following entity types can be represented by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Transfers, custom Fees, and Split Transfers."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"type":"number","format":"double","example":"63.307","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"currency":{"$ref":"#/components/schemas/currency"},"entity_id":{"type":"string","description":"The ID of the related entity."},"entity_details":{"type":"object","description":"An object containing additional details about the entity.","properties":{"fee_category":{"type":"string","description":"The category of the fee.","nullable":true,"enum":["PROCESSOR","INTERCHANGE","DUES_AND_ASSESSMENTS","THIRD_PARTY_SERVICE_PROVIDER"]}}},"entity_type":{"type":"string","description":"The type of the related entity.","enum":["TRANSFER","CUSTOM_FEE","SPLIT_TRANSFER","FEE"]},"parent_entity_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the original parent resource where the transaction occurred. This is only populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FEE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"parent_entity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the original parent resource where the transaction occurred. This is only populated when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FEE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["TRANSFER"]},"subtype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The subtype of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"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":"DISPUTE_MERCHANT_DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/split-transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/disputes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pulls funds from a merchant proportionally. Only applies when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPLIT_TRANSFER"},"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":"code","inline":true,"attributes":{"content":"DISPUTE_MERCHANT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ruled in favor of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and funds are returned proportionally. Only applies when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SPLIT_TRANSFER"},"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":"code","inline":true,"attributes":{"content":"REFUND_MERCHANT_DEBIT_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created to debit the refund amount from the merchant's settlement when a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds/pending-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"held refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can't be covered. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_entity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the ID of the held refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND_MERCHANT_CREDIT_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created to credit the refund amount back when a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds/pending-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"held refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is submitted or expires. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent_entity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the ID of the held refund."},"children":[]}]}]}]}],"enum":["DEBIT","CREDIT","FEE","REVERSAL","ADJUSTMENT","DISPUTE","DISPUTE_MERCHANT_DEBIT","DISPUTE_MERCHANT_CREDIT","REFUND_MERCHANT_DEBIT_ADJUSTMENT","REFUND_MERCHANT_CREDIT_ADJUSTMENT","CUSTOM"]},"ready_to_settle_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp of when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ready to be settled."},"children":[]}]}]}],"nullable":true},"should_fund":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether funds should be moved for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":true}}}},"components/schemas/removeSettlementEntries":{"id":"components/schemas/removeSettlementEntries","kind":"json-schema","title":"removeSettlementEntries","data":{"type":"object","properties":{"settlement_entry_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"items":{"type":"string"}}}}},"components/schemas/fee_transfer":{"id":"components/schemas/fee_transfer","kind":"json-schema","title":"fee_transfer","data":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum amount of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"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":"text","inline":true,"attributes":{"content":"If the fees applied by the 'Fee Profile' are "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"higher"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than the value passed in 'fee', 'fee' will not be applied and have no effect."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the fees applied by the 'Fee Profile' are "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lower"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"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":"text","inline":true,"attributes":{"content":"The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}]}},"components/schemas/funds_flow_type":{"id":"components/schemas/funds_flow_type","kind":"json-schema","title":"funds_flow_type","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of disbursement to perform. Defaults to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GENERAL_PAYOUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["GENERAL_PAYOUT","ME_TO_ME","GOVERNMENT"],"nullable":true}},"components/schemas/transfer":{"id":"components/schemas/transfer","kind":"json-schema","title":"transfer","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"3d_secure_session":{"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":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that authenticated the buyer. This field is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the payment was not authenticated with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"3d_secure_session_f3fG3Zj8K958MTP5vpXAXX"},"additional_buyer_charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The buyer charges are mutually exclusive."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"additional_healthcare_data":{"$ref":"#/components/schemas/additional_healthcare_data"},"additional_lodging_data":{"$ref":"#/components/schemas/additional_lodging_data"},"additional_motor_vehicle_rental_data":{"$ref":"#/components/schemas/additional_motor_vehicle_rental_data"},"additional_purchase_data":{"$ref":"#/components/schemas/additional_purchase_data"},"address_verification":{"type":"string","description":"Details the results of the address verification checks.","nullable":true,"enum":["POSTAL_CODE_AND_STREET_MATCH","STREET_MATCH","POSTAL_CODE_MATCH","NO_ADDRESS","NO_MATCH","NOT_SUPPORTED","UNKNOWN"]},"amount":{"$ref":"#/components/schemas/amount"},"amount_requested":{"type":"integer","format":"int64","description":[{"$$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":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was requested to get debited from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the transaction was created, in cents (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"100"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = $1.00)."},"children":[]}]}]}],"example":100},"application":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the resource."},"children":[]}]}]}]},"bank_return_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about a transfer that was returned and was unable to be processed. Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RETURNED"},"children":[]}]}]}],"nullable":true,"properties":{"reason_code":{"type":"string","description":"Return response code from the bank."},"reason_message":{"type":"string","description":"Detailed message explaining reason for the return."},"reason_title":{"type":"string","description":"Short message categorizing reason for the return."}}},"card_present_details":{"type":"object","description":"Details needed to process card present transactions.","nullable":true,"properties":{"approval_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique ID used to identify the approval of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"brand":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The brand of the card saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"emv_data":{"type":"object","description":"Encrypted card data used to process the transaction.","nullable":true,"properties":{"application_identifier":{"type":"string","description":"ID of the application used in the transaction. Tag 9F06 from the EMVCo standard.","nullable":true},"application_label":{"type":"string","description":"EMV application label. Tag 50 from the EMVCo standard.","nullable":true},"application_preferred_name":{"type":"string","description":"EMV application label with formatting (if provided). Tag 9F12 from the EMVCo standard.","nullable":true},"application_transaction_counter":{"type":"string","description":"Transaction number for the EMV application. Tag 9F36 from the EMVCo standard.","nullable":true},"cryptogram":{"type":"string","description":"Cryptogram returned by the card. Tag 9F26 of the EMVCo standard.","nullable":true},"issuer_code_table_index":{"type":"string","description":"The alphabet code table (according to ISO 8859) used by the EMV application (if provided). Tag 9F11.","nullable":true},"network_emv_response":{"type":"string","description":"EMV response data returned by the card network.","nullable":true},"pin_verified":{"type":"boolean","description":"Whether the cardholder's PIN number was verified."},"tags":{"$ref":"#/components/schemas/tags"}}},"entry_mode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the card payment method used to process the transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The possible enums are:"},"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":"UNKNOWN - The method by which the payment card was used is unknown."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SWIPED - The card was swiped through a POS terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CONTACTLESS - The payment was made by tapping a card on a POS terminal."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHIP_ENTRY - The payment card was inserted into a card reader."},"children":[]}]}]}]}],"enum":["UNKNOWN","SWIPED","CONTACTLESS","CHIP_ENTRY"],"nullable":true},"masked_account_number":{"type":"string","description":"Last four digits of the bank account number.","nullable":true},"name":{"type":"string","description":"The name of the bank account or card owner.","nullable":true},"digital_signature_file_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the file containing the digital signature captured during the transaction. If a signature was not collected, this field returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"payment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used in the transaction (or the original payment)."},"children":[]}]}]}],"nullable":true}}},"currency":{"$ref":"#/components/schemas/currency"},"created_via":{"$ref":"#/components/schemas/created_via_transfers_authorizations"},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where funds will be sent."},"children":[]}]}]}],"nullable":true},"device":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"externally_funded":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be settled externally by card processors."},"children":[]}]}]}]},"expires_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp indicating when a held refund expires. Only returned for reversals created with refund holds enabled. A refund that can't be covered by this time fails with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure_code: REFUND_EXPIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds/pending-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending refunds"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"failure_code":{"$ref":"#/components/schemas/failure_code"},"failure_message":{"$ref":"#/components/schemas/failure_message"},"fee":{"$ref":"#/components/schemas/fee_transfer"},"fee_profile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will be used for calculating fees for this transfer."},"children":[]}]}]}]},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"idempotency_id":{"$ref":"#/components/schemas/idempotency_id"},"ip_address_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}],"example":"MUxxxxxxxxxxxxxxxxxxxxxxx"},"merchant_identity":{"type":"string","example":"IDxxxxxxxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource used by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"messages":{"type":"array","description":"A list of messages that provides additional details.","nullable":true,"items":{"type":"string"}},"network_details":{"type":"object","nullable":true,"description":"Contains network-specific fields used by issuers to identify transactions.","properties":{"brand":{"type":"string","description":"Card brand associated with the saved payment instrument.","example":"VISA"},"authorization_code":{"type":"string","description":"Code returned by the issuing bank when a transaction is authorized.","example":840735},"acquirer_reference_number":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier banks use to trace chargebacks or refunds. Available only for Mastercard transactions; otherwise returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"example":521600805857}}},"operation_key":{"type":"string","enum":["CARD_NOT_PRESENT_CAPTURE","CARD_NOT_PRESENT_REFUND","CARD_NOT_PRESENT_SALE","CARD_NOT_PRESENT_UNREFERENCED_REFUND","CARD_PRESENT_AUTHORIZATION","CARD_PRESENT_DEBIT","CARD_PRESENT_SALE","CARD_PRESENT_UNREFERENCED_REFUND","INSTANT_APPLICATION_FUNDING_PULL_FROM_ACH","INSTANT_APPLICATION_FUNDING_PULL_FROM_CARD","INSTANT_APPLICATION_FUNDING_PULL_FROM_FED_NOW","INSTANT_APPLICATION_FUNDING_PULL_FROM_SAME_DAY_ACH","INSTANT_APPLICATION_FUNDING_PUSH_TO_ACH","INSTANT_APPLICATION_FUNDING_PUSH_TO_CARD","INSTANT_APPLICATION_FUNDING_PUSH_TO_FED_NOW","INSTANT_APPLICATION_FUNDING_PUSH_TO_SAME_DAY_ACH","INSTANT_MERCHANT_FUNDING_PULL_FROM_ACH","INSTANT_MERCHANT_FUNDING_PULL_FROM_FED_NOW","INSTANT_MERCHANT_FUNDING_PULL_FROM_SAME_DAY_ACH","INSTANT_MERCHANT_FUNDING_PUSH_TO_ACH","INSTANT_MERCHANT_FUNDING_PUSH_TO_CARD","INSTANT_MERCHANT_FUNDING_PUSH_TO_FED_NOW","INSTANT_MERCHANT_FUNDING_PUSH_TO_SAME_DAY_ACH","MERCHANT_CREDIT_ADJUSTMENT","MERCHANT_DEBIT_ADJUSTMENT","PULL_FROM_ACH","PULL_FROM_CARD","PULL_FROM_SAME_DAY_ACH","PUSH_TO_ACH","PUSH_TO_CARD","PUSH_TO_SAME_DAY_ACH","REFUND_MERCHANT_CREDIT_ADJUSTMENT","REFUND_MERCHANT_DEBIT_ADJUSTMENT","SALE","STANDARD_APPLICATION_FUNDING_PULL_FROM_ACH","STANDARD_APPLICATION_FUNDING_PULL_FROM_CARD","STANDARD_APPLICATION_FUNDING_PULL_FROM_SAME_DAY_ACH","STANDARD_APPLICATION_FUNDING_PUSH_TO_ACH","STANDARD_APPLICATION_FUNDING_PUSH_TO_CARD","STANDARD_APPLICATION_FUNDING_PUSH_TO_SAME_DAY_ACH","STANDARD_MERCHANT_FUNDING_PULL_FROM_ACH","STANDARD_MERCHANT_FUNDING_PULL_FROM_CARD","STANDARD_MERCHANT_FUNDING_PULL_FROM_SAME_DAY_ACH","STANDARD_MERCHANT_FUNDING_PUSH_TO_ACH","STANDARD_MERCHANT_FUNDING_PUSH_TO_CARD","STANDARD_MERCHANT_FUNDING_PUSH_TO_SAME_DAY_ACH","UNREFERENCED_REFUND"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The operation performed in the transaction. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND_MERCHANT_DEBIT_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND_MERCHANT_CREDIT_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are created by Finix for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds/pending-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund holds"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and cannot be passed in requests."},"children":[]}]}]}],"nullable":true},"parent_transfer":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the original parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"parent_transfer_trace_id":{"type":"string","description":[{"$$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":"trace_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the original parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"processed_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp of when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was processed."},"children":[]}]}]}],"nullable":true},"pull_transfer_id":{"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":"The ID of the corresponding pull "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" linked in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]}]},"raw":{"description":"Raw response from the processor.","anyOf":[{"type":"object","nullable":true},{"type":"string","nullable":true}]},"ready_to_settle_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp indicating when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ready to be settled."},"children":[]}]}]}],"nullable":true},"receipt_last_printed_at":{"type":"string","format":"date-time","description":"Timestamp when the receipt was last printed.","nullable":true},"security_code_verification":{"type":"string","nullable":true,"description":"Details the results of the Card Verification Code check.","enum":["MATCHED","UNKNOWN","UNMATCHED"]},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will be debited and performing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"split_transfers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array containing the resource IDs of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" generated from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"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":"For standard split transactions, this contains IDs of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"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":"For "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/disputes/listdisputesadjustments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute adjustment transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on split transactions:"},"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":"When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MERCHANT_DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MERCHANT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" adjustment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is created for a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/disputes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a split transaction, this array contains the IDs of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created for each participant."},"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":"Split Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are created proportionally based on each merchant's share of the original sale."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"../../../../guides/online-payments/payment-features/split-transactions#disputes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions - Disputes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"default":[],"items":{"type":"string"}},"state":{"type":"string","enum":["CANCELED","PENDING","FAILED","SUCCEEDED","UNKNOWN","RETURNED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"subtype":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information describing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_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":"For "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/disputes/listdisputesadjustments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispute adjustment transfers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: DISPUTE"},"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":"MERCHANT_DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Funds are pulled from the merchant(s) when a chargeback occurs. For split transactions, this creates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: DISPUTE_MERCHANT_DEBIT"},"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":"code","inline":true,"attributes":{"content":"MERCHANT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Funds are returned to the merchant(s) when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ruled in their favor. For split transactions, this creates "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: DISPUTE_MERCHANT_CREDIT"},"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":"For "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds/pending-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"refund hold"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" adjustment transfers:"},"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":"REFUND_MERCHANT_DEBIT_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Funds are pulled from the merchant to cover a held refund."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REFUND_MERCHANT_CREDIT_ADJUSTMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Funds are returned to the merchant when the held refund is submitted or expires."},"children":[]}]}]}]}],"enum":["API","DISPUTE","MERCHANT_CREDIT","MERCHANT_CREDIT_ADJUSTMENT","MERCHANT_DEBIT","MERCHANT_DEBIT_ADJUSTMENT","PLATFORM_CREDIT","PLATFORM_CREDIT_ADJUSTMENT","PLATFORM_DEBIT","PLATFORM_DEBIT_ADJUSTMENT","REFUND_MERCHANT_CREDIT_ADJUSTMENT","REFUND_MERCHANT_DEBIT_ADJUSTMENT","SETTLEMENT_MERCHANT","SETTLEMENT_NOOP","SETTLEMENT_PARTNER","SETTLEMENT_PLATFORM","SPLIT_PAYOUT","SPLIT_PAYOUT_ADJUSTMENT","SYSTEM"]},"supplemental_fee":{"type":"string","description":"Amount in cents for which an additional fee will be created in addition to any fees created from the assigned fee profile.","nullable":true},"tags":{"$ref":"#/components/schemas/tags"},"tip_amount":{"type":"integer","description":"The tip amount included in the total amount.","nullable":true},"trace_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trace ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The processor sends back the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trace_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so you can track the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" end-to-end."},"children":[]}]}]}],"nullable":true},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["DEBIT","CREDIT","REVERSAL","ADJUSTMENT","DISPUTE","RESERVE","SETTLEMENT","UNKNOWN"]},"third_party_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the third-party processor associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"properties":{"external_trace_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The trace ID returned by the third-party processor used to identify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the third-party processor associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"enum":["CYBERSOURCE"]}}},"_links":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/application_link"},"destination":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where funds are getting sent."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"device":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"disputes":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"fee_profile":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fee_profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request was made under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"fees":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fees"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the request is associated with."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"merchant_identity":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was submitted with."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"payment_instruments":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the Transfer."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"disputed_transfer":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is about."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"parent":{"type":"object","description":"Link to the original resource that was used in the request.","properties":{"href":{"type":"string"}}},"reversals":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reversals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"self":{"$ref":"#/components/schemas/self"},"source":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}}}}}},"components/schemas/deleteSettlementTransfers":{"id":"components/schemas/deleteSettlementTransfers","kind":"json-schema","title":"deleteSettlementTransfers","data":{"type":"object","properties":{"transfers":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"items":{"type":"string"}}}}},"components/schemas/SettlementFundingTransferAttempt":{"id":"components/schemas/SettlementFundingTransferAttempt","kind":"json-schema","title":"SettlementFundingTransferAttempt","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"application":{"$ref":"#/components/schemas/application_id"},"currency":{"$ref":"#/components/schemas/currency"},"funding_transfer_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to track the payout."},"children":[]}]}]}]},"instrument_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to use for the instant payout."},"children":[]}]}]}],"nullable":true},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MUxxxxxxxxxxxxxxxxxxxxxxx"},"failure_code":{"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":"The error code when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fails."},"children":[]}]}]}],"enum":["BALANCE_ACCOUNT_NOT_FOUND","BALANCE_VALIDATION_FAILED","INSUFFICIENT_BALANCE","INVALID_BALANCE_ACCOUNT","VELOCITY_LIMIT_EXCEEDED","VELOCITY_RULE_NOT_FOUND","VELOCITY_VALIDATION_FAILED"]},"failure_message":{"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":"A human-readable message describing why the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" failed. Corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"failure_code"},"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":"BALANCE_ACCOUNT_NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Balance Account not found. Please contact support if you have questions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BALANCE_VALIDATION_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Balance Validation failed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INSUFFICIENT_BALANCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Your account balance is insufficient for this operation. Please contact support if you have any questions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INVALID_BALANCE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Balance Account is invalid."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VELOCITY_LIMIT_EXCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Dynamically generated based on the violated rule. Examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Daily volume limit exceeded for APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monthly count limit exceeded for RECIPIENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Maximum amount exceeded for SENDER"},"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":"code","inline":true,"attributes":{"content":"VELOCITY_RULE_NOT_FOUND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Velocity Rule not found. Please contact support if you have any questions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VELOCITY_VALIDATION_FAILED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Velocity Validation failed. Please contact support if you have any questions."},"children":[]}]}]}]}]},"state":{"type":"string","enum":["PENDING","FAILED","SUCCEEDED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"settlement_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource used for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Funding Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}}}}}}},"components/schemas/createSettlementFundingTransferAttempt":{"id":"components/schemas/createSettlementFundingTransferAttempt","kind":"json-schema","title":"createSettlementFundingTransferAttempt","data":{"type":"object","properties":{"amount":{"type":"number","description":"The amount in cents to be paid out via instant payout."},"instrument_id":{"type":"string","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to submit the funds. The instrument must currently be of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAYMENT_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/settlement_queue_entry":{"id":"components/schemas/settlement_queue_entry","kind":"json-schema","title":"settlement_queue_entry","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application_id":{"$ref":"#/components/schemas/application_id"},"entity_id":{"type":"string","description":"The ID of the related resource."},"entity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entity the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked to."},"children":[]}]}]}],"enum":["ADJUSTMENT","DISPUTE_TRANSFER","FEE","TRANSFER","REVERSE","SPLIT_TRANSFER"]},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource the entity was created for and will settle under."},"children":[]}]}]}]},"platform_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique identifier for the Platform where the entity associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created."},"children":[]}]}]}]},"ready_to_settle_after":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A timestamp indicating when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be processed for settlement."},"children":[]}]}]}],"nullable":true},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The current state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["AWAITING_SETTLEMENT_TIME","PENDING","RELEASED"]},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]}}}}}}}},"components/schemas/releaseSettlementQueueEntries":{"id":"components/schemas/releaseSettlementQueueEntries","kind":"json-schema","title":"releaseSettlementQueueEntries","data":{"type":"object","properties":{"action":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the action to be performed on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RELEASE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" action to release a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Reversal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources, placing them into a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}],"enum":["RELEASE"]},"ids":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of IDs representing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Settlement Queue Entry"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources on which to apply the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/createTransferMinimalFields":{"id":"components/schemas/createTransferMinimalFields","kind":"json-schema","title":"Transfer - Minimal Fields","data":{"title":"Transfer - Minimal Fields","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferAllFields":{"id":"components/schemas/createTransferAllFields","kind":"json-schema","title":"Transfer - All Fields","data":{"title":"Transfer - All Fields","properties":{"3d_secure_authentication":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3D secure information required to create a 3D secure "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/3d_secure_authentication"}]},"additional_buyer_charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The buyer charges are mutually exclusive."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"additional_purchase_data":{"$ref":"#/components/schemas/additional_purchase_data"},"amount":{"$ref":"#/components/schemas/amount"},"credential_on_file":{"description":"Indicates that this transaction uses stored payment credentials (credential-on-file), meaning the cardholder previously authorized the merchant to save and reuse their payment details.","nullable":true,"properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of credential on file transfer. Must be one of the following values:"},"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":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A transfer that is part of a series of transfers scheduled at regular intervals. Interchange benefits for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions are available only to approved bill payment merchants in the telecommunications and cable industries (MCC 4814 and 4899)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNSCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A merchant-initiated, one-time transaction using stored credentials, triggered when specific conditions in a cardholder agreement are met—not on a fixed schedule."},"children":[]}]}]}]}],"enum":["RECURRING","UNSCHEDULED"]}}},"currency":{"$ref":"#/components/schemas/currency"},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where funds will be sent. This field is only applicable to card or bank payouts."},"children":[]}]}]}],"nullable":true},"device":{"type":"string","description":"The unique identifier of the activated device. This field is only applicable to card-present payments.","nullable":true},"fee_profile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional field to specify which fee_profile to use for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If not provided, the currently assigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be used."},"children":[]}]}]}],"nullable":true},"idempotency_id":{"$ref":"#/components/schemas/idempotency_id"},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to run the card present sale. Finix tokenizes the card associated with the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and processes the sale, removing the need to create a blank buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ip_address_v4":{"$ref":"#/components/schemas/ip_address_v4"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"operation_key":{"type":"string","enum":["CARD_NOT_PRESENT_SALE","CARD_NOT_PRESENT_UNREFERENCED_REFUND","CARD_PRESENT_DEBIT","CARD_PRESENT_SALE","CARD_PRESENT_UNREFERENCED_REFUND","MERCHANT_CREDIT_ADJUSTMENT","MERCHANT_DEBIT_ADJUSTMENT","PULL_FROM_CARD","PUSH_TO_ACH","PUSH_TO_CARD","PUSH_TO_SAME_DAY_ACH","SALE","UNREFERENCED_REFUND"],"description":"Details the operation that is be performed in the transaction.","nullable":true},"partial_authorization":{"type":"boolean","description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable partial authorizations for a specific transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"partial_authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled for an individual transaction, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default_partial_authorization_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disregarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial authorizations enable you to collect a portion of the amount if the cardholder does not have the funds to cover the entire amount."},"children":[]}]}]}]}]},"receipt_options":{"type":"object","description":"If provided, the information will be used to generate a receipt if the transaction is successful. These settings are used only for receipts via devices.","nullable":true,"properties":{"additional_details":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of key-value pairs for including metadata or custom information related to the receipt. Each entry must contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These fields are currently supported for device-generated receipts only."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The label or title for the additional detail. This should be a short, human-readable identifier such as \"Invoice Number\", \"VIN\", \"Service Date\", or \"Technician\".","maxLength":25,"example":"Invoice Number"},"value":{"type":"string","description":"The corresponding value for the detail. This can be any string that provides relevant context or information, such as an invoice number, vehicle identification number, or date.","maxLength":25,"example":"4FEBVZP0-0002"}},"required":["name","value"]}},"amount_breakdown":{"$ref":"#/components/schemas/amount_breakdown"},"items":{"$ref":"#/components/schemas/items"},"requested_delivery_methods":{"$ref":"#/components/schemas/requested_delivery_methods"}}},"security_code":{"$ref":"#/components/schemas/security_code"},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where funds get debited."},"children":[]}]}]}]},"split_transfers":{"description":[{"$$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 array used to detail how funds from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will split and the amount "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submitted in the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/split-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/split_transfers"}]},"statement_descriptor":{"type":"string","maxLength":20,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that appears on the card statement."},"children":[]}]}]}]},"supplemental_fee":{"type":"integer","format":"int64","description":"Amount in cents for which an additional fee will be created in addition to any fees created from the assigned fee profile.","nullable":true},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferCanadaEFT":{"id":"components/schemas/createTransferCanadaEFT","kind":"json-schema","title":"Transfer - Canada - EFT","data":{"title":"Transfer - Canada - EFT","allOf":[{"$ref":"#/components/schemas/createTransferMinimalFields"}]}},"components/schemas/createTransfer3DSecure":{"id":"components/schemas/createTransfer3DSecure","kind":"json-schema","title":"Transfer - 3D Secure","data":{"title":"Transfer - 3D Secure","properties":{"3d_secure_authentication":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3D secure information required to create a 3D secure "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/3d_secure_authentication"}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransfer3DSecureSession":{"id":"components/schemas/createTransfer3DSecureSession","kind":"json-schema","title":"Transfer - 3D Secure Session","data":{"title":"Transfer - 3D Secure Session","type":"object","properties":{"3d_secure_session":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used for the buyer's authentication flow. It must correspond to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must not already have been used by another transaction. For the redirect flow, wait for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state: SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; with Finix.js, submit after the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"succeeded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" callback even if the resource still reads "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"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 field is mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when Finix runs the authentication, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3d_secure_authentication"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you authenticate the buyer with your own 3D Secure vendor."},"children":[]}]}]}],"example":"3d_secure_session_9hK2mNp4T761RBv8qwLDYc"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"merchant_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3D Secure Session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["3d_secure_session","amount","currency","merchant","source"]}},"components/schemas/createTransferBankPayout":{"id":"components/schemas/createTransferBankPayout","kind":"json-schema","title":"Transfer - Bank Payout","data":{"title":"Transfer - Bank Payout","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will receive the payout."},"children":[]}]}]}]},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PUSH_TO_ACH"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key indicating the type of operation. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/bank-payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Payouts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for an explanation of \"Next Day\" versus \"Same Day\" ACH."},"children":[]}]}]}]}},"required":["amount","currency","operation_key","destination"]}},"components/schemas/createTransferBankPayoutSameDay":{"id":"components/schemas/createTransferBankPayoutSameDay","kind":"json-schema","title":"Transfer - Bank Payout - Same Day","data":{"title":"Transfer - Bank Payout - Same Day","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will receive the payout."},"children":[]}]}]}]},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PUSH_TO_SAME_DAY_ACH"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key indicating the type of operation. Refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/bank-payouts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bank Payouts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide for an explanation of \"Next Day\" versus \"Same Day\" ACH."},"children":[]}]}]}]}},"required":["amount","currency","operation_key","destination"]}},"components/schemas/pull_transfer_id":{"id":"components/schemas/pull_transfer_id","kind":"json-schema","title":"pull_transfer_id","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the corresponding pull "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" linked in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]}],"nullable":true}},"components/schemas/createTransferCardPayout":{"id":"components/schemas/createTransferCardPayout","kind":"json-schema","title":"Transfer - Card Payout","data":{"title":"Transfer - Card Payout","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will receive the payout."},"children":[]}]}]}]},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PUSH_TO_CARD"],"description":"A key indicating that the operation type should be a card payout."},"pull_transfer_id":{"allOf":[{"$ref":"#/components/schemas/pull_transfer_id"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the corresponding pull "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_flow_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The linked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must:"},"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":"Have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_SAME_DAY_ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Be associated with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tied to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]}]}]}]}},"required":["amount","currency","operation_key","destination"]}},"components/schemas/createTransferCardPresent":{"id":"components/schemas/createTransferCardPresent","kind":"json-schema","title":"Transfer - Card Present","data":{"title":"Transfer - Card Present","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"device":{"type":"string","description":"The ID of the activated device."},"identity":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to run the card present sale. Finix tokenizes the card associated with the provided "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and processes the sale, removing the need to create a blank buyer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"operation_key":{"type":"string","enum":["CARD_PRESENT_SALE"],"description":"A key indicating that the operation type should be a card-present sale."},"receipt_options":{"type":"object","description":"If provided the information will be used to generate a receipt if transaction is successful.","properties":{"additional_details":{"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of key-value pairs for including metadata or custom information related to the receipt. Each entry must contain a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as strings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These fields are currently supported for device-generated receipts only."},"children":[]}]}]}],"items":{"type":"object","properties":{"name":{"type":"string","description":"The label or title for the additional detail. This should be a short, human-readable identifier such as \"Invoice Number\", \"VIN\", \"Service Date\", or \"Technician\".","maxLength":25,"example":"Invoice Number"},"value":{"type":"string","description":"The corresponding value for the detail. This can be any string that provides relevant context or information, such as an invoice number, vehicle identification number, or date.","maxLength":25,"example":"4FEBVZP0-0002"}},"required":["name","value"]}},"amount_breakdown":{"$ref":"#/components/schemas/amount_breakdown"},"items":{"$ref":"#/components/schemas/items"},"requested_delivery_methods":{"$ref":"#/components/schemas/requested_delivery_methods"}}}},"required":["amount","currency","device","operation_key"]}},"components/schemas/createTransferUnreferencedRefund":{"id":"components/schemas/createTransferUnreferencedRefund","kind":"json-schema","title":"Transfer - Card Present - Unreferenced Refund","data":{"title":"Transfer - Card Present - Unreferenced Refund","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request fields to perform an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds#unreferenced-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unreferenced refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"device":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"operation_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide the operation key for an "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds#unreferenced-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unreferenced refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["CARD_PRESENT_UNREFERENCED_REFUND"],"nullable":true}},"required":["amount","currency","device","operation_key"]}},"components/schemas/createTransferCardVerificationCheck":{"id":"components/schemas/createTransferCardVerificationCheck","kind":"json-schema","title":"Transfer - Card Verification Checks","data":{"title":"Transfer - Card Verification Checks","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"security_code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The 3-or 4-digit security code for the card (i.e., the CVV code). Include the CVV code of the card to perform "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/fraud-and-risk/risk-rules-card-checks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Card Verification Checks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferConvenienceFee":{"id":"components/schemas/createTransferConvenienceFee","kind":"json-schema","title":"Transfer - Convenience Fee","data":{"title":"Transfer - Convenience Fee","properties":{"additional_buyer_charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The buyer charges are mutually exclusive."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferDebitBankAccount":{"id":"components/schemas/createTransferDebitBankAccount","kind":"json-schema","title":"Transfer - Debit Bank Account","data":{"title":"Transfer - Debit Bank Account","allOf":[{"$ref":"#/components/schemas/createTransferMinimalFields"}]}},"components/schemas/createTransferFeeProfile":{"id":"components/schemas/createTransferFeeProfile","kind":"json-schema","title":"Transfer - Fee Profile","data":{"title":"Transfer - Fee Profile","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"fee_profile":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/fee-profiles"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fee Profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to apply to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferAutoRental":{"id":"components/schemas/createTransferAutoRental","kind":"json-schema","title":"Transfer - Motor Vehicle Rental","data":{"title":"Transfer - Motor Vehicle Rental","properties":{"additional_motor_vehicle_rental_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing motor vehicle rental-specific fields for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional for motor vehicle rental MCC transactions (MCC 3351–3500, 7512)."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_motor_vehicle_rental_data"}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"idempotency_id":{"$ref":"#/components/schemas/idempotency_id"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferLodging":{"id":"components/schemas/createTransferLodging","kind":"json-schema","title":"Transfer - Lodging","data":{"title":"Transfer - Lodging","properties":{"additional_lodging_data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing lodging-specific fields for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Optional for lodging MCC transactions (MCC 3501–3999, 7011)."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_lodging_data"}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"idempotency_id":{"$ref":"#/components/schemas/idempotency_id"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferGaming":{"id":"components/schemas/createTransferGaming","kind":"json-schema","title":"Transfer - Gaming","data":{"title":"Transfer - Gaming","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"ip_address_v4":{"$ref":"#/components/schemas/ip_address_v4"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferLvl2Processing":{"id":"components/schemas/createTransferLvl2Processing","kind":"json-schema","title":"Transfer - Level 2 Processing","data":{"title":"Transfer - Level 2 Processing","properties":{"additional_purchase_data":{"$ref":"#/components/schemas/additional_purchase_data"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"},"statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferLvl3Processing":{"id":"components/schemas/createTransferLvl3Processing","kind":"json-schema","title":"Transfer - Level 3 Processing","data":{"title":"Transfer - Level 3 Processing","properties":{"additional_purchase_data":{"$ref":"#/components/schemas/additional_purchase_data"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"},"statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferPartialAuthorization":{"id":"components/schemas/createTransferPartialAuthorization","kind":"json-schema","title":"Transfer - Partial Authorization","data":{"title":"Transfer - Partial Authorization","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"partial_authorization":{"type":"boolean","description":[{"$$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":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you want to enable partial authorizations for a specific transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"partial_authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled for an individual transaction, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default_partial_authorization_enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is disregarded."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial authorizations enable you to collect a portion of the amount if the cardholder does not have the funds to cover the entire amount."},"children":[]}]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferRecurringUnscheduled":{"id":"components/schemas/createTransferRecurringUnscheduled","kind":"json-schema","title":"Transfer - Recurring or Unscheduled","data":{"title":"Transfer - Recurring or Unscheduled","properties":{"amount":{"$ref":"#/components/schemas/amount"},"credential_on_file":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An object that contains information about the credential on file transfer."},"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":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The type of credential on file transfer. Must be one of the following values:"},"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":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A transfer that is part of a series of transfers scheduled at regular intervals. Interchange benefits for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transactions are available only to approved bill payment merchants in the telecommunications and cable industries (MCC 4814 and 4899)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNSCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A merchant-initiated, one-time transaction using stored credentials, triggered when specific conditions in a cardholder agreement are met—not on a fixed schedule."},"children":[]}]}]}]}]}]}],"type":"object","properties":{"type":{"type":"string","enum":["RECURRING","UNSCHEDULED"]}}},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferRentSurcharge":{"id":"components/schemas/createTransferRentSurcharge","kind":"json-schema","title":"Transfer - Rent Surcharge","data":{"title":"Transfer - Rent Surcharge","properties":{"additional_buyer_charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The buyer charges are mutually exclusive."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferSplitTransaction":{"id":"components/schemas/createTransferSplitTransaction","kind":"json-schema","title":"Transfer - Split Transaction","data":{"title":"Transfer - Split Transaction","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"},"split_transfers":{"description":[{"$$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 array used to detail how funds from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will split and the amount "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submitted in the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/split-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/split_transfers"}]}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferSurcharge":{"id":"components/schemas/createTransferSurcharge","kind":"json-schema","title":"Transfer - Surcharge","data":{"title":"Transfer - Surcharge","properties":{"additional_buyer_charges":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about any "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/buyer-charges"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Buyer Charges"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The buyer charges are mutually exclusive."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/additional_buyer_charges"}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"merchant":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"source":{"$ref":"#/components/schemas/source"}},"required":["amount","currency","merchant","source"]}},"components/schemas/createTransferMeToMePullCard":{"id":"components/schemas/createTransferMeToMePullCard","kind":"json-schema","title":"Transfer - Me to Me Pull - Card","data":{"title":"Transfer - Me to Me Pull - Card","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PULL_FROM_CARD"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key indicating that the operation type should be a card pull for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]}],"nullable":false},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to pull funds from."},"children":[]}]}]}]}},"required":["amount","currency","operation_key","source"]}},"components/schemas/createTransferMeToMePullBank":{"id":"components/schemas/createTransferMeToMePullBank","kind":"json-schema","title":"Transfer - Me to Me Pull - Bank","data":{"title":"Transfer - Me to Me Pull - Bank","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PULL_FROM_ACH"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key indicating that the operation type should be an ACH pull for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]}],"nullable":false},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to pull funds from."},"children":[]}]}]}]}},"required":["amount","currency","operation_key","source"]}},"components/schemas/createTransferMeToMePullBankSameDay":{"id":"components/schemas/createTransferMeToMePullBankSameDay","kind":"json-schema","title":"Transfer - Me to Me Pull - Bank - Same Day","data":{"title":"Transfer - Me to Me Pull - Bank - Same Day","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PULL_FROM_SAME_DAY_ACH"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key indicating that the operation type should be a same-day ACH pull for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]}],"nullable":false},"source":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to pull funds from."},"children":[]}]}]}]}},"required":["amount","currency","operation_key","source"]}},"components/schemas/createTransferMeToMePayoutCard":{"id":"components/schemas/createTransferMeToMePayoutCard","kind":"json-schema","title":"Transfer - Me to Me Payout - Card","data":{"title":"Transfer - Me to Me Payout - Card","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will receive the payout."},"children":[]}]}]}]},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PUSH_TO_CARD"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key indicating that the operation type should be a card payout for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]}],"nullable":false},"pull_transfer_id":{"allOf":[{"$ref":"#/components/schemas/pull_transfer_id"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the corresponding pull "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_flow_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The linked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must:"},"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":"Have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_SAME_DAY_ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Be associated with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tied to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have the same currency and amount"},"children":[]}]}]}]}]}]}},"required":["amount","currency","operation_key","destination","pull_transfer_id"]}},"components/schemas/createTransferMeToMePayoutBank":{"id":"components/schemas/createTransferMeToMePayoutBank","kind":"json-schema","title":"Transfer - Me to Me Payout - Bank","data":{"title":"Transfer - Me to Me Payout - Bank","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will receive the payout."},"children":[]}]}]}]},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PUSH_TO_ACH"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key indicating that the operation type should be an ACH payout for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]}],"nullable":false},"pull_transfer_id":{"allOf":[{"$ref":"#/components/schemas/pull_transfer_id"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the corresponding pull "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_flow_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The linked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must:"},"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":"Have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_SAME_DAY_ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Be associated with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tied to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have the same currency and amount"},"children":[]}]}]}]}]}]}},"required":["amount","currency","operation_key","destination","pull_transfer_id"]}},"components/schemas/createTransferMeToMePayoutBankSameDay":{"id":"components/schemas/createTransferMeToMePayoutBankSameDay","kind":"json-schema","title":"Transfer - Me to Me Payout - Bank - Same Day","data":{"title":"Transfer - Me to Me Payout - Bank - Same Day","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"$ref":"#/components/schemas/currency"},"destination":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifier of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that will receive the payout."},"children":[]}]}]}]},"funds_flow_type":{"$ref":"#/components/schemas/funds_flow_type"},"operation_key":{"type":"string","enum":["PUSH_TO_SAME_DAY_ACH"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key indicating that the operation type should be a same-day ACH payout for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]}],"nullable":false},"pull_transfer_id":{"allOf":[{"$ref":"#/components/schemas/pull_transfer_id"},{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the corresponding pull "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to link for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" transaction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"funds_flow_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ME_TO_ME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The linked "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must:"},"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":"Have an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_CARD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_ACH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PULL_FROM_SAME_DAY_ACH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Be associated with the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tied to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Have the same currency and amount"},"children":[]}]}]}]}]}]}},"required":["amount","currency","operation_key","destination","pull_transfer_id"]}},"components/schemas/updateTransfer":{"id":"components/schemas/updateTransfer","kind":"json-schema","title":"updateTransfer","data":{"type":"object","properties":{"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/createTransferReversal":{"id":"components/schemas/createTransferReversal","kind":"json-schema","title":"Refund Transfer","data":{"title":"Refund Transfer","properties":{"refund_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the refund in cents. It must be equal to or less than the amount of the original "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["refund_amount"]}},"components/schemas/createTransferReversalSplitTransaction":{"id":"components/schemas/createTransferReversalSplitTransaction","kind":"json-schema","title":"Refund Transfer - Split Transaction","data":{"title":"Refund Transfer - Split Transaction","properties":{"refund_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the refund in cents. It must be equal to or less than the amount of the original "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"split_transfers":{"description":[{"$$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 array used to detail how funds from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will split and the amount "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" receive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The combined "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"split_transfers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" submitted in the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/online-payments/payment-features/split-transactions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Split Transactions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"allOf":[{"$ref":"#/components/schemas/split_transfers"}]}},"required":["refund_amount"]}},"components/schemas/createTransferReversalReferencedRefund":{"id":"components/schemas/createTransferReversalReferencedRefund","kind":"json-schema","title":"Refund Card Present Transfer - Referenced","data":{"title":"Refund Card Present Transfer - Referenced","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request fields to perform a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/after-the-payment/refunds#referenced-refunds"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"referenced refund"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"device":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"refund_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The amount of the refund in cents. It must be equal to or less than the amount of the original "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"required":["refund_amount"]}},"components/schemas/transfer_attempt_pending_code":{"id":"components/schemas/transfer_attempt_pending_code","kind":"json-schema","title":"transfer_attempt_pending_code","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reason the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not applicable."},"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":"MICRODEPOSIT_VERIFICATION_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The Bank account is pending microdeposit verification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRANSFER_PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The underlying transfer is currently in a state of Pending."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECIPIENT_VERIFICATION_REQUIRED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The recipient for the transfer is being verified."},"children":[]}]}]}]}],"enum":["MICRODEPOSIT_VERIFICATION_REQUIRED","TRANSFER_PENDING","RECIPIENT_VERIFICATION_REQUIRED"],"nullable":true}},"components/schemas/transfer_attempt_pending_message":{"id":"components/schemas/transfer_attempt_pending_message","kind":"json-schema","title":"transfer_attempt_pending_message","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable description of why the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when not applicable."},"children":[]}]}]}],"nullable":true}},"components/schemas/TransferAttemptCheckoutForm":{"id":"components/schemas/TransferAttemptCheckoutForm","kind":"json-schema","title":"Transfer Attempt - Checkout Form","data":{"title":"Transfer Attempt - Checkout Form","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" originating from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checkout Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"application_id":{"type":"string","description":[{"$$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":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"APfwZU6VSXNGRZi3ouEyLjAW"},"authorization_id":{"type":"string","description":[{"$$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":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]},"buyer_details":{"type":"object","description":"Object containing details about the buyer.","properties":{"first_name":{"type":"string","description":"First name of the buyer."},"last_name":{"type":"string","description":"Last name of the buyer."},"email":{"description":"Email address of the buyer.","type":"string"},"identity_id":{"type":"string","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"phone":{"description":"Phone number of the buyer.","type":"string","nullable":true},"billing_address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The primary address associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"properties":{"city":{"type":"string","minLength":1,"maxLength":20,"description":"City.","nullable":true},"country":{"$ref":"#/components/schemas/country"},"line1":{"type":"string","minLength":1,"maxLength":35,"description":"The first line of the address.","nullable":true},"line2":{"type":"string","minLength":1,"maxLength":35,"description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","minLength":1,"maxLength":7,"description":"The zip or postal code.","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true}}},"shipping_address":{"description":"Shipping or mailing address of the buyer.","type":"object","nullable":true,"properties":{"city":{"type":"string","minLength":1,"maxLength":20,"description":"City.","nullable":true},"country":{"$ref":"#/components/schemas/country"},"line1":{"type":"string","minLength":1,"maxLength":35,"description":"The first line of the address.","nullable":true},"line2":{"type":"string","minLength":1,"maxLength":35,"description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","minLength":1,"maxLength":7,"description":"The zip or postal code.","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true}}}}},"currency":{"$ref":"#/components/schemas/currency"},"entity_id":{"type":"string","description":[{"$$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":"Checkout Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"entity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of entity that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["CHECKOUT_FORM"]},"failure_code":{"$ref":"#/components/schemas/failure_code"},"failure_message":{"$ref":"#/components/schemas/failure_message"},"is_authorization":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created from an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the Merchant linked to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checkout Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MUmfEGv5bMpSJ9k5TFRUjkmm"},"microdeposit_verification_url":{"type":"string","description":"The URL of the hosted microdeposit verification page.","nullable":true},"operation_key":{"$ref":"#/components/schemas/operation_key"},"payment_frequency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field does not apply to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources originating from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Checkout Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will always return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"payment_instrument_id":{"type":"string","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be debited upon success of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"pending_code":{"$ref":"#/components/schemas/transfer_attempt_pending_code"},"pending_message":{"$ref":"#/components/schemas/transfer_attempt_pending_message"},"receipt_requested_delivery_methods":{"$ref":"#/components/schemas/receipt_requested_delivery_methods"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PENDING","FAILED","SUCCEEDED"]},"statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"tags":{"$ref":"#/components/schemas/tags"},"recipient_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the recipient of the payout. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for checkout form transfer attempts."},"children":[]}]}]}],"nullable":true,"properties":{"business_name":{"type":"string","description":"The recipient's legal business name. For a sole proprietorship, pass the owner's legal first name, last name, and middle initial.","nullable":true},"doing_business_as":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"email":{"type":"string","description":"Email address of the recipient.","nullable":true},"first_name":{"type":"string","description":"First name of the recipient."},"last_name":{"type":"string","description":"Last name of the recipient."},"phone":{"type":"string","description":"Phone number of the recipient.","nullable":true},"type":{"type":"string","description":"The type of recipient.","enum":["PERSONAL","BUSINESS"]}}},"recipient_merchant_id":{"type":"string","description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource linked to the recipient."},"children":[]}]}]}],"nullable":true},"transfer_id":{"type":"string","description":[{"$$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":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status if the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been created yet."},"children":[]}]}]}],"example":"TR4XqdopsgBJmeVZznfFr9LZ","nullable":true},"type":{"type":"string","enum":["DEBIT","CREDIT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/TransferAttemptPaymentLink":{"id":"components/schemas/TransferAttemptPaymentLink","kind":"json-schema","title":"Transfer Attempt - Payment Link","data":{"title":"Transfer Attempt - Payment Link","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" originating from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"additional_buyer_charges":{"$ref":"#/components/schemas/additional_buyer_charges"},"amount_requested":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was requested to get debited from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"source"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the transaction was created."},"children":[]}]}]}]},"application_id":{"type":"string","description":[{"$$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":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"APfwZU6VSXNGRZi3ouEyLjAW"},"authorization_id":{"type":"string","description":[{"$$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":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}],"nullable":true},"buyer_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing details about the buyer. This object is only used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SINGLE_USE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payment links."},"children":[]}]}]}],"properties":{"first_name":{"type":"string","description":"First name of the buyer."},"last_name":{"type":"string","description":"Last name of the buyer."},"email":{"description":"Email address of the buyer.","type":"string"},"identity_id":{"type":"string","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"phone":{"description":"Phone number of the buyer.","type":"string","nullable":true},"billing_address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The primary address associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"properties":{"city":{"type":"string","minLength":1,"maxLength":20,"description":"City.","nullable":true},"country":{"$ref":"#/components/schemas/country"},"line1":{"type":"string","minLength":1,"maxLength":35,"description":"The first line of the address.","nullable":true},"line2":{"type":"string","minLength":1,"maxLength":35,"description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","minLength":1,"maxLength":7,"description":"The zip or postal code.","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true}}},"shipping_address":{"description":"Shipping or mailing address of the buyer.","type":"object","nullable":true,"properties":{"city":{"type":"string","minLength":1,"maxLength":20,"description":"City.","nullable":true},"country":{"$ref":"#/components/schemas/country"},"line1":{"type":"string","minLength":1,"maxLength":35,"description":"The first line of the address.","nullable":true},"line2":{"type":"string","minLength":1,"maxLength":35,"description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","minLength":1,"maxLength":7,"description":"The zip or postal code.","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true}}}}},"currency":{"$ref":"#/components/schemas/currency"},"entity_id":{"type":"string","description":[{"$$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":"Payment Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"entity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of entity that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PAYMENT_LINK"]},"failure_code":{"$ref":"#/components/schemas/failure_code"},"failure_message":{"$ref":"#/components/schemas/failure_message"},"is_authorization":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created from an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MUmfEGv5bMpSJ9k5TFRUjkmm"},"microdeposit_verification_url":{"type":"string","description":"The URL of the hosted microdeposit verification page.","nullable":true},"operation_key":{"$ref":"#/components/schemas/operation_key"},"payment_frequency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is single-use or recurring."},"children":[]}]}]}],"default":"ONE_TIME","enum":["ONE_TIME","RECURRING"]},"payment_instrument_id":{"type":"string","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be debited upon success of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"pending_code":{"$ref":"#/components/schemas/transfer_attempt_pending_code"},"pending_message":{"$ref":"#/components/schemas/transfer_attempt_pending_message"},"receipt_requested_delivery_methods":{"$ref":"#/components/schemas/receipt_requested_delivery_methods"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PENDING","FAILED","SUCCEEDED"]},"statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"tags":{"$ref":"#/components/schemas/tags"},"recipient_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details of the recipient of the payout. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for payment link transfer attempts."},"children":[]}]}]}],"nullable":true,"properties":{"business_address":{"type":"object","description":"The primary address for the legal entity.","nullable":true,"properties":{"city":{"type":"string","description":"City.","nullable":true},"country":{"type":"string","description":"3-letter ISO 3166 country code.","nullable":true},"region":{"type":"string","description":"2-letter state or region code.","nullable":true},"line1":{"type":"string","description":"The first line of the address.","nullable":true},"line2":{"type":"string","description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","description":"The zip or postal code.","nullable":true}}},"business_name":{"type":"string","description":"The recipient's legal business name. For a sole proprietorship, pass the owner's legal first name, last name, and middle initial.","nullable":true},"doing_business_as":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"email":{"type":"string","description":"Email address of the recipient.","nullable":true},"first_name":{"type":"string","description":"First name of the recipient.","nullable":true},"last_name":{"type":"string","description":"Last name of the recipient.","nullable":true},"personal_address":{"type":"object","description":"The home address of the principal control owner.","nullable":true,"properties":{"city":{"type":"string","description":"City.","nullable":true},"country":{"type":"string","description":"3-letter ISO 3166 country code.","nullable":true},"region":{"type":"string","description":"2-letter state or region code.","nullable":true},"line1":{"type":"string","description":"The first line of the address.","nullable":true},"line2":{"type":"string","description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","description":"The zip or postal code.","nullable":true}}},"phone":{"type":"string","description":"Phone number of the recipient.","nullable":true},"type":{"type":"string","description":"The type of recipient.","enum":["PERSONAL","BUSINESS"],"nullable":true}}},"recipient_merchant_id":{"type":"string","description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource linked to the recipient."},"children":[]}]}]}],"nullable":true},"transfer_id":{"type":"string","description":[{"$$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":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status if the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been created yet."},"children":[]}]}]}],"example":"TR4XqdopsgBJmeVZznfFr9LZ","nullable":true},"type":{"type":"string","enum":["DEBIT","CREDIT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/TransferAttemptPayoutLink":{"id":"components/schemas/TransferAttemptPayoutLink","kind":"json-schema","title":"Transfer Attempt - Payout Link","data":{"title":"Transfer Attempt - Payout Link","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" originating from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"application_id":{"type":"string","description":[{"$$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":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"APfwZU6VSXNGRZi3ouEyLjAW"},"authorization_id":{"type":"string","description":[{"$$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":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", if applicable."},"children":[]}]}]}]},"buyer_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field does not apply to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources originating from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will always return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"first_name":{"type":"string","description":"First name of the buyer."},"last_name":{"type":"string","description":"Last name of the buyer."},"email":{"description":"Email address of the buyer.","type":"string"},"identity_id":{"type":"string","description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"phone":{"description":"Phone number of the buyer.","type":"string"},"billing_address":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The primary address associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"city":{"type":"string","minLength":1,"maxLength":20,"description":"City.","nullable":true},"country":{"$ref":"#/components/schemas/country"},"line1":{"type":"string","minLength":1,"maxLength":35,"description":"The first line of the address.","nullable":true},"line2":{"type":"string","minLength":1,"maxLength":35,"description":"The second line of the address.","nullable":true},"postal_code":{"type":"string","minLength":1,"maxLength":7,"description":"The zip or postal code.","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true}}}},"nullable":true},"currency":{"$ref":"#/components/schemas/currency"},"entity_id":{"type":"string","description":[{"$$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":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"entity_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of entity that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PAYOUT_LINK"]},"failure_code":{"$ref":"#/components/schemas/failure_code"},"failure_message":{"$ref":"#/components/schemas/failure_message"},"is_authorization":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created from an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that initiated the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MUmfEGv5bMpSJ9k5TFRUjkmm","nullable":true},"microdeposit_verification_url":{"type":"string","description":"The URL of the hosted microdeposit verification page.","nullable":true},"operation_key":{"$ref":"#/components/schemas/operation_key"},"payment_frequency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field does not apply to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources originating from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will always return "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"payment_instrument_id":{"type":"string","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be credited upon success of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"pending_code":{"$ref":"#/components/schemas/transfer_attempt_pending_code"},"pending_message":{"$ref":"#/components/schemas/transfer_attempt_pending_message"},"receipt_requested_delivery_methods":{"$ref":"#/components/schemas/receipt_requested_delivery_methods"},"recipient_details":{"type":"object","description":"Details of the recipient of the payout.","properties":{"business_address":{"type":"object","description":"The primary address for the legal entity.","nullable":true,"properties":{"city":{"type":"string","description":"City (max 20 characters).","minLength":1,"nullable":true},"country":{"type":"string","minLength":1},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters).","nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters).","nullable":true}}},"business_name":{"type":"string","minLength":1,"description":"Abbreviated names of the business. If there are no abbreviated name, leave this field blank.","nullable":true},"doing_business_as":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (max 60 characters)."},"children":[]}]}]}],"nullable":true},"email":{"type":"string","minLength":1,"description":"The email address of the principal control owner (max 100 characters).","nullable":true},"first_name":{"type":"string","minLength":1,"description":"The legal first name of the control owner (max 20 characters)."},"last_name":{"type":"string","minLength":1,"description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" owner's legal last name."},"children":[]}]}]}]},"personal_address":{"type":"object","description":"The home address of the principal control owner. This field is used for identity verification purposes.","properties":{"city":{"type":"string","minLength":1,"description":"City (max 20 characters)."},"country":{"type":"string","minLength":1,"description":"3-Letter country code (e.g. USA)."},"region":{"type":"string","minLength":1,"description":"2-letter State code."},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters)."},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters)."}}},"personal_tax_id_provided":{"type":"boolean","description":"Whether a personal tax ID was provided by the recipient."},"business_tax_id_provided":{"type":"boolean","description":"Whether a business tax ID was provided by the recipient."},"phone":{"type":"string","minLength":1,"description":"The principal control owner's phone number (max 10 characters).","nullable":true},"type":{"type":"string","description":"Whether the recipient is considered \"PERSONAL\" or a \"BUSINESS\".","enum":["PERSONAL","BUSINESS"]}}},"recipient_merchant_id":{"type":"string","description":[{"$$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":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource linked to the recipient targeted by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payout Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"MUs6gqsciLh1vRtKMuw6MR8B"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PENDING","FAILED","SUCCEEDED"]},"statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"tags":{"$ref":"#/components/schemas/tags"},"transfer_id":{"type":"string","description":[{"$$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":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer Attempt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PENDING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status if the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has not been created yet."},"children":[]}]}]}],"example":"TR4XqdopsgBJmeVZznfFr9LZ","nullable":true},"type":{"type":"string","enum":["CREDIT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/user":{"id":"components/schemas/user","kind":"json-schema","title":"user","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"created_by":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the application user that created "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"_"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user."},"children":[]}]}]}]},"email":{"type":"string","minLength":1,"nullable":true,"description":"The email address of the application user (max 100 characters)."},"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled and active. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"first_name":{"type":"string","description":"The first name of the User ID (Max 50 characters).","nullable":true,"maxLength":50},"identity":{"type":"string","example":"IDxxxxxxxxxxxxxxxxxx","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object was created under."},"children":[]}]}]}],"nullable":true},"last_name":{"type":"string","description":"The last name of the User ID (Max 50 characters).","nullable":true,"maxLength":50},"last_used_date":{"type":"string","format":"date","nullable":true,"description":"Date when the user credentials were last used to make an API call."},"password":{"type":"string","description":[{"$$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":"password"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you'll use to authetnicate requests."},"children":[]}]}]}],"nullable":true},"role":{"enum":["ROLE_PLATFORM","ROLE_PARTNER","ROLE_MERCHANT"],"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details the level of access the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Users"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has available."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"application":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the resource was created under."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}},"applications":{"type":"object","properties":{"href":{"type":"string"}}},"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}}}}}}},"components/schemas/updateUser":{"id":"components/schemas/updateUser","kind":"json-schema","title":"Update User","data":{"title":"Update User","type":"object","properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled and active. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateUserTags":{"id":"components/schemas/updateUserTags","kind":"json-schema","title":"Update User - Update Tags","data":{"title":"Update User - Update Tags","allOf":[{"$ref":"#/components/schemas/updateUser"}]}},"components/schemas/updateUserDisable":{"id":"components/schemas/updateUserDisable","kind":"json-schema","title":"Update User - Disable","data":{"title":"Update User - Disable","allOf":[{"$ref":"#/components/schemas/updateUser"}]}},"components/schemas/enabled_events":{"id":"components/schemas/enabled_events","kind":"json-schema","title":"enabled_events","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of webhook events to enable for API entities."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There can be only one enabled event object per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity"},"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 list is optional and overrides default webhook events. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/webhook-events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to learn which events are automatically subscribed at creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When included in a PUT request, this list replaces all previously configured events."},"children":[]}]}]}],"items":{"type":"object","properties":{"entity":{"type":"string","description":"The API entity for which you want to receive webhook events.\n","example":"transfer"},"types":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of webhook event types you want to receive for the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entity"},"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":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/webhook-events"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook Events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" guide to learn which values are accepted for each entity."},"children":[]}]}]}],"items":{"type":"string","example":"created"}}}}}},"components/schemas/webhook":{"id":"components/schemas/webhook","kind":"json-schema","title":"webhook","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"$ref":"#/components/schemas/application_id"},"authentication":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credentials included in webhook POST requests so your server can confirm each request originated from Finix."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn about the different authentication methods, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks#managing-webhooks-via-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing Webhooks via API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"type":{"type":"string","enum":["NONE","BASIC","BEARER"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of authentication the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will use:"},"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":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": No authentication will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Basic authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BEARER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": OAuth2 Bearer Token."},"children":[]}]}]}]}],"default":"NONE"}}},"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is enabled. Disabled webhooks will not receive events."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Events are sent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"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":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Events are not sent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"default":true},"enabled_events":{"$ref":"#/components/schemas/enabled_events"},"is_accepting_events":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently accepting events; this field mirrors the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}]},"nickname":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable name for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"previous_secret_expires_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the previous "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secret_signing_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expires. Set when the signing key is rotated; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on initial creation."},"children":[]}]}]}],"nullable":true},"secret_signing_key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this key to verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Finix-Signature"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header on incoming webhook events, confirming the payload came from Finix, was not tampered with, and was sent recently. For details, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks#verifying-webhook-signatures-finix-signature"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying Webhook Signatures"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"url":{"type":"string","description":"The HTTP or HTTPS URL to receive events. When an event occurs, Finix sends a POST request to this URL with the webhook event payload."},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"application":{"$ref":"#/components/schemas/application_link"},"self":{"$ref":"#/components/schemas/self"}}}}}},"components/schemas/authentication":{"id":"components/schemas/authentication","kind":"json-schema","title":"authentication","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credentials included in webhook POST requests so your server can confirm each request originated from Finix."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn about the different authentication methods, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks#managing-webhooks-via-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing Webhooks via API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"basic":{"type":"object","description":"A basic authentication configuration provided by the user.","properties":{"password":{"type":"string","description":"A user-provided basic authentication password."},"username":{"type":"string","description":"A user-provided basic authentication username."}}},"bearer":{"type":"object","description":"A bearer authentication configuration.","properties":{"token":{"type":"string","description":"The string that Finix will send as the bearer token."}}},"type":{"type":"string","enum":["NONE","BASIC","BEARER"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of authentication the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will use:"},"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":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - No authentication will be used."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BASIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Basic authentication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BEARER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - OAuth2 Bearer Token."},"children":[]}]}]}]}],"default":"NONE"}}}},"components/schemas/createWebhookAllFields":{"id":"components/schemas/createWebhookAllFields","kind":"json-schema","title":"Webhook - All Fields","data":{"type":"object","title":"Webhook - All Fields","properties":{"authentication":{"$ref":"#/components/schemas/authentication"},"enabled_events":{"$ref":"#/components/schemas/enabled_events"},"nickname":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable name for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"url":{"type":"string","description":"The HTTP or HTTPS URL to receive events. When an event occurs, Finix sends a POST request to this URL with the webhook event payload.","example":"https://httpbin.org/post"}},"required":["url"]}},"components/schemas/createWebhookMinimalFields":{"id":"components/schemas/createWebhookMinimalFields","kind":"json-schema","title":"Webhook - Minimal Fields - No Authentication","data":{"type":"object","title":"Webhook - Minimal Fields - No Authentication","properties":{"url":{"type":"string","description":"The HTTP or HTTPS URL to receive events. When an event occurs, Finix sends a POST request to this URL with the webhook event payload.","example":"https://httpbin.org/post"}},"required":["url"]}},"components/schemas/createWebhookBasicAuthentication":{"id":"components/schemas/createWebhookBasicAuthentication","kind":"json-schema","title":"Webhook - Basic Authentication","data":{"type":"object","title":"Webhook - Basic Authentication","properties":{"authentication":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credentials included in webhook POST requests so your server can confirm each request originated from Finix."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn about the different authentication methods, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks#managing-webhooks-via-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing Webhooks via API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"basic":{"type":"object","description":"A basic authentication configuration provided by the user.","properties":{"password":{"type":"string","description":"A user-provided basic authentication password."},"username":{"type":"string","description":"A user-provided basic authentication username."}},"required":["password","username"]},"type":{"type":"string","enum":["BASIC"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of authentication the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will use:"},"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":"BASIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Basic authentication."},"children":[]}]}]}]}]}},"required":["basic","type"]},"url":{"type":"string","description":"The HTTP or HTTPS URL to receive events. When an event occurs, Finix sends a POST request to this URL with the webhook event payload.","example":"https://httpbin.org/post"}},"required":["url"]}},"components/schemas/createWebhookBearerToken":{"id":"components/schemas/createWebhookBearerToken","kind":"json-schema","title":"Webhook - Bearer Token","data":{"title":"Webhook - Bearer Token","type":"object","properties":{"authentication":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credentials included in webhook POST requests so your server can confirm each request originated from Finix."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To learn about the different authentication methods, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/additional-resources/developers/webhooks/integrating-into-webhooks#managing-webhooks-via-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing Webhooks via API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"bearer":{"type":"object","description":"A bearer authentication configuration.","properties":{"token":{"type":"string","description":"The string that Finix will send as the bearer token."}},"required":["token"]},"type":{"type":"string","enum":["BEARER"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of authentication the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will use:"},"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":"BEARER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - OAuth2 Bearer Token."},"children":[]}]}]}]}]}},"required":["bearer","type"]},"url":{"type":"string","description":"The HTTP or HTTPS URL to receive events. When an event occurs, Finix sends a POST request to this URL with the webhook event payload.","example":"https://httpbin.org/post"}},"required":["url"]}},"components/schemas/createWebhookEventFiltering":{"id":"components/schemas/createWebhookEventFiltering","kind":"json-schema","title":"Webhook - Event Filtering","data":{"type":"object","title":"Webhook - Event Filtering","properties":{"authentication":{"$ref":"#/components/schemas/authentication"},"enabled_events":{"$ref":"#/components/schemas/enabled_events"},"url":{"type":"string","description":"The HTTP or HTTPS URL to receive callbacks. When an enabled event occurs, Finix sends a POST request to this URL with the webhook event payload.","example":"https://httpbin.org/post"}},"required":["url"]}},"components/schemas/updateWebhookAllFields":{"id":"components/schemas/updateWebhookAllFields","kind":"json-schema","title":"Update Webhook - All Fields","data":{"type":"object","title":"Update Webhook - All Fields","properties":{"authentication":{"$ref":"#/components/schemas/authentication"},"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable or disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Disabled webhooks will not receive events."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - webhook events are sent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"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":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - webhook events are not sent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},"enabled_events":{"$ref":"#/components/schemas/enabled_events"},"generate_new_secret":{"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":"Triggers rotation of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'s HMAC signing key. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the current key is stored as the previous key, a new key is generated, and the new secret is returned in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"previous_secret_active_hours"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be set."},"children":[]}]}]}]},"nickname":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-readable name for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"previous_secret_active_hours":{"type":"integer","minimum":0,"maximum":24,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls how long the old signing key remains valid alongside the new one during rotation. Both keys can verify signatures during this window. A value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means the old key expires immediately."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generate_new_secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; forbidden otherwise."},"children":[]}]}]}]},"url":{"type":"string","description":"The HTTP or HTTPS URL to receive events. When an event occurs, Finix sends a POST request to this URL with the webhook event payload.","example":"https://httpbin.org/post"}}}},"components/schemas/updateWebhookAuthentication":{"id":"components/schemas/updateWebhookAuthentication","kind":"json-schema","title":"Update Webhook - Add Authentication to a Webhook","data":{"type":"object","title":"Update Webhook - Add Authentication to a Webhook","properties":{"authentication":{"$ref":"#/components/schemas/authentication"}}}},"components/schemas/updateWebhookEnableDisable":{"id":"components/schemas/updateWebhookEnableDisable","kind":"json-schema","title":"Update Webhook - Enable/Disable Webhook Events","data":{"type":"object","title":"Update Webhook - Enable/Disable Webhook Events","properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable or disable the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Webhook"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Disabled webhooks will not receive events."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - webhook events are sent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"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":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - webhook events are not sent to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}}}},"components/schemas/updateWebhookEventFiltering":{"id":"components/schemas/updateWebhookEventFiltering","kind":"json-schema","title":"Update Webhook - Filter Events","data":{"type":"object","title":"Update Webhook - Filter Events","properties":{"enabled_events":{"$ref":"#/components/schemas/enabled_events"}}}},"components/schemas/file":{"id":"components/schemas/file","kind":"json-schema","title":"file","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application_id":{"$ref":"#/components/schemas/application_id"},"display_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The human-readable name of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The file name format is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<type>_<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by default."},"children":[]}]}]}]},"entity_id":{"type":"string","description":"The ID of the underwriting note associated with the attached file.","nullable":true},"entity_type":{"type":"string","description":"The entity type assigned to the underwriting note.","enum":["NOTE"],"nullable":true},"extension":{"description":"The extension of the file.","type":"string","nullable":true,"example":"png"},"file_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the uploaded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". It is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is first created and is automatically updated to the uploaded file's name. You cannot change this field."},"children":[]}]}]}],"type":"string","example":"bank_statement_01_2024.png","nullable":true},"identity_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}],"nullable":true},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked to. This can be either a Merchant ID or Identity ID."},"children":[]}]}]}],"example":"MU2n7BSovtwYsWYZF6rBnnzk"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is linked to."},"children":[]}]}]}]},"platform_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created under."},"children":[]}]}]}]},"size_in_bytes":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The size of the uploaded "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in bytes. It is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource is first created and updates automatically after a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is uploaded."},"children":[]}]}]}],"nullable":true},"status":{"type":"string","description":"The file's upload status.","enum":["REQUIRES_UPLOAD","PENDING","UPLOADED","INVALID"]},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":"The type of document. Finix may return more enums than those provided. Ensure your code accepts additional enums returned by Finix.","enum":["BANK_STATEMENT","BANK_STATEMENT_ONE_MONTH","BANK_STATEMENT_THREE_MONTHS","BUSINESS_ADDRESS_DOCUMENT","BUSINESS_ADDRESS_VERIFICATION","BUSINESS_INCORPORATION_DOCUMENT","BUSINESS_OWNERSHIP_STRUCTURE","BUSINESS_REGISTRATION","BUSINESS_REGISTRATION_DOCUMENT","BUSINESS_TAX_EXEMPTION_STATUS_DOCUMENT","BUSINESS_TAX_ID_DOCUMENT","DEVICE_IDLE_IMAGE","DIGITAL_SIGNATURE","DRIVERS_LICENSE_BACK","DRIVERS_LICENSE_FRONT","ENHANCED_DUE_DILIGENCE_DOCUMENT","IDENTIFICATION_CARD_BACK","IDENTIFICATION_CARD_FRONT","OTHER","OWNER_GOVERNMENT_ISSUED_PHOTO_ID","OWNER_TAX_ID_DOCUMENT","PASSPORT","PCI_DOCUMENT","PROCESSING_STATEMENT","SCREEN_RECORDING","TAX_DOCUMENT","VIDEO_DOCUMENT"]}}}},"components/schemas/createFile":{"id":"components/schemas/createFile","kind":"json-schema","title":"createFile","data":{"type":"object","properties":{"display_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The human-readable name to use for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Bank Statement"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be linked to. This can be either a Merchant ID or Identity ID."},"children":[]}]}]}],"example":"MU2n7BSovtwYsWYZF6rBnnzk"},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":"The type of document.","enum":["BANK_STATEMENT","BANK_STATEMENT_ONE_MONTH","BANK_STATEMENT_THREE_MONTHS","BUSINESS_ADDRESS_DOCUMENT","BUSINESS_ADDRESS_VERIFICATION","BUSINESS_INCORPORATION_DOCUMENT","BUSINESS_OWNERSHIP_STRUCTURE","BUSINESS_REGISTRATION","BUSINESS_REGISTRATION_DOCUMENT","BUSINESS_TAX_EXEMPTION_STATUS_DOCUMENT","BUSINESS_TAX_ID_DOCUMENT","DEVICE_IDLE_IMAGE","DIGITAL_SIGNATURE","DRIVERS_LICENSE_BACK","DRIVERS_LICENSE_FRONT","ENHANCED_DUE_DILIGENCE_DOCUMENT","IDENTIFICATION_CARD_BACK","IDENTIFICATION_CARD_FRONT","OTHER","OWNER_GOVERNMENT_ISSUED_PHOTO_ID","OWNER_TAX_ID_DOCUMENT","PASSPORT","PCI_DOCUMENT","PROCESSING_STATEMENT","SCREEN_RECORDING","TAX_DOCUMENT","VIDEO_DOCUMENT"]}},"required":["linked_to","type"]}},"components/schemas/external_link":{"id":"components/schemas/external_link","kind":"json-schema","title":"external_link","data":{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}]},"created_at":{"$ref":"#/components/schemas/created_at"},"duration":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details how long (in minutes) the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid for."},"children":[]}]}]}],"nullable":true},"expired":{"type":"boolean","description":"Whether the external link has expired."},"expires_at":{"type":"string","format":"date-time","description":"When the external link expires."},"file_id":{"type":"string","description":[{"$$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":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ID the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"External Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" relates to."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":"Sets whether the link uploads or downloads files from Finix.","enum":["UPLOAD","DOWNLOAD","VIEW"]},"url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL that can be used to upload, download, or view the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"user_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that requested to create this link."},"children":[]}]}]}]}}}},"components/schemas/createExternalLink":{"id":"components/schemas/createExternalLink","kind":"json-schema","title":"createExternalLink","data":{"type":"object","properties":{"duration":{"type":"integer","description":"Set how long (in minutes) the external link is valid for. The link can be valid for up to 10080 minutes (7 days).","maximum":10080},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the type of external link to create."},"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":"UPLOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Create a link that can be used to upload files to Finix."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DOWNLOAD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Create a link where the uploaded file can be downloaded from."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"VIEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Create a link that displays the file in browser."},"children":[]}]}]}]}],"enum":["DOWNLOAD","UPLOAD","VIEW"]}},"required":["type"]}},"components/schemas/createExternalLinkUpload":{"id":"components/schemas/createExternalLinkUpload","kind":"json-schema","title":"External Link - Upload","data":{"title":"External Link - Upload","allOf":[{"$ref":"#/components/schemas/createExternalLink"}]}},"components/schemas/createExternalLinkDownload":{"id":"components/schemas/createExternalLinkDownload","kind":"json-schema","title":"External Link - Download","data":{"title":"External Link - Download","allOf":[{"$ref":"#/components/schemas/createExternalLink"}]}},"components/schemas/createExternalLinkView":{"id":"components/schemas/createExternalLinkView","kind":"json-schema","title":"External Link - View","data":{"title":"External Link - View","allOf":[{"$ref":"#/components/schemas/createExternalLink"}]}},"components/schemas/uploadFile":{"id":"components/schemas/uploadFile","kind":"json-schema","title":"uploadFile","data":{"type":"object","properties":{"file":{"type":"string","description":"Path to the file to upload.","example":"@/Users/Desktop/finix_file.png"}},"required":["file"]}},"components/schemas/file_download":{"id":"components/schemas/file_download","kind":"json-schema","title":"file_download","data":{"type":"string","format":"binary","description":"The file in question will begin to download."}},"components/schemas/createApplePaySession":{"id":"components/schemas/createApplePaySession","kind":"json-schema","title":"Payment Instrument - Apple Pay Session","data":{"type":"object","title":"Payment Instrument - Apple Pay Session","properties":{"display_name":{"type":"string","description":"This will be the merchant name shown to users when making a purchase via Apple Pay."},"domain":{"type":"string","description":"The domain (or website) where the buyer is initiating the payment."},"merchant_identity":{"type":"string","description":[{"$$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":"merchant_identity_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used when registering the business with Apple Pay through our registration API."},"children":[]}]}]}]},"validation_url":{"type":"string","description":"A unique validation URL that will be provided by the Apple SDK front-end for every payment."}}}},"components/schemas/payment_instrument_apple_pay_session":{"id":"components/schemas/payment_instrument_apple_pay_session","kind":"json-schema","title":"Payment Instrument - Apple Pay Session","data":{"type":"object","title":"Payment Instrument - Apple Pay Session","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"session_details":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details about the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apple_pay_session"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was created."},"children":[]}]}]}]},"_links":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make your follow-up requests and quickly access relevant IDs."},"children":[]}]}]}],"properties":{"self":{"type":"object","description":"Link to the resource that was used in the request.","properties":{"href":{"type":"string"}}}}}}}},"components/schemas/compliance_form":{"id":"components/schemas/compliance_form","kind":"json-schema","title":"compliance_form","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs."},"children":[]}]}]}],"type":"string","x-stoplight":{"id":"z19ttkxt3mfpa"}},"compliance_form_template":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the template used to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"due_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is due. By default, this is 3 months after the form was created."},"children":[]}]}]}]},"files":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IDs of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources for the signed and unsigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PDFs."},"children":[]}]}]}],"properties":{"signed_file":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource for the signed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PDF."},"children":[]}]}]}],"default":null,"nullable":true},"unsigned_file":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"File"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource for the unsigned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" PDF."},"children":[]}]}]}]}}},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the resource to which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs."},"children":[]}]}]}]},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of the resource to which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" belongs."},"children":[]}]}]}],"enum":["MERCHANT"]},"pci_saq_a":{"type":"object","description":"Details about the signee's digital signature","properties":{"ip_address":{"type":"string","description":"The IP address of the signee.","nullable":true},"is_accepted":{"type":"boolean","default":false,"description":"Whether the signee has signed the form."},"name":{"type":"string","description":"The full name of the signee.","nullable":true},"signed_at":{"type":"string","description":"The timestamp of the signee's signature.","nullable":true},"title":{"type":"string","description":"The job title of the signee.","nullable":true},"user_agent":{"type":"string","description":"The User-Agent string of the signee's device.","nullable":true}}},"state":{"type":"string","enum":["INCOMPLETE","OVERDUE","COMPLETE","EXPIRED","INVALID"],"default":"INCOMPLETE","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["PCI_SAQ_A"]},"valid_from":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp of when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid from. This is set to the form's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp upon signature."},"children":[]}]}]}],"format":"date-time","nullable":true},"valid_until":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp of when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is valid until. This is set to one year after the form's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signed_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp upon signature."},"children":[]}]}]}],"format":"date-time","nullable":true},"version":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The version of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Compliance Form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/completeComplianceForm":{"id":"components/schemas/completeComplianceForm","kind":"json-schema","title":"completeComplianceForm","data":{"type":"object","properties":{"pci_saq_a":{"type":"object","description":"Details about the signee's digital signature.","properties":{"ip_address":{"type":"string","description":"The IP address of the signee."},"name":{"type":"string","description":"Full name of the signee"},"signed_at":{"type":"string","description":"The timestamp of the signee's signature."},"title":{"type":"string","description":"The job title of the signee."},"user_agent":{"type":"string","description":"The User-Agent of the Merchant attesting to the form."}}}},"required":["pci_saq_a"]}},"components/schemas/onboarding_data":{"id":"components/schemas/onboarding_data","kind":"json-schema","title":"onboarding_data","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The prefilled information of the user that's being onboarded. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-forms/#prefilling-fields"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Prefilling Fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"additional_underwriting_data":{"type":"object","description":"Additional underwriting data about the user.","properties":{"annual_ach_volume":{"type":"integer","description":"The approximate annual ACH sales expected to be processed (in cents) by this merchant (max 10 characters)."},"average_ach_transfer_amount":{"type":"integer","description":"The approximate average ACH sale amount (in cents) for this merchant."},"average_card_transfer_amount":{"type":"integer","description":"The average credit card sale amount (in cents) for this merchant."},"business_description":{"type":"string","minLength":1,"description":"Description of this merchant's business (max 200 characters)."},"card_volume_distribution":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The distribution of the merchant's credit card volume The sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_volume_distribution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be 100."},"children":[]}]}]}],"nullable":true,"properties":{"card_present_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's card present (between 0 and 100)."},"ecommerce_percentage":{"type":"integer","description":"The percentage of the merchant's business that is eCommerce (between 0 and 100)."},"mail_order_telephone_order_percentage":{"type":"integer","description":"The percentage of the merchant's business that is a mail or telephone order (between 0 and 100)."}}},"credit_check_timestamp":{"type":"string","nullable":true,"minLength":1,"description":"A timestamp of when this merchant consented to a credit check (e.g., 2021-04-28T16:42:55Z)."},"credit_check_user_agent":{"type":"string","nullable":true,"minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the browser that was used when this merchant consented to a credit check (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6))."},"children":[]}]}]}]},"merchant_agreement_accepted":{"type":"boolean","description":"Sets whether this merchant has accepted the terms and conditions of the merchant agreement."},"merchant_agreement_ip_address":{"type":"string","minLength":1,"description":"IP address of the merchant when this merchant accepted the merchant agreement (e.g., 42.1.1.113)."},"merchant_agreement_timestamp":{"type":"string","minLength":1,"description":"Timestamp of when the merchant accepted Finix's Terms of Service (e.g., 2021-04-28T16:42:55Z)."},"merchant_agreement_user_agent":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The details of the browser that was used when this merchant accepted Finix's Terms of Service (e.g., Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6))."},"children":[]}]}]}]},"refund_policy":{"type":"string","minLength":1,"description":"Include the value that best applies to the merchant's refund policy.","enum":["NO_REFUNDS","MERCHANDISE_EXCHANGE_ONLY","WITHIN_30_DAYS","OTHER"]},"volume_distribution_by_business_type":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant's distribution of credit card volume by business type. Sum of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"volume_distribution_by_business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be 100."},"children":[]}]}]}],"nullable":true,"properties":{"business_to_business_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's business to business (between 0 and 100)."},"business_to_consumer_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that's business to consumer (between 0 and 100)."},"consumer_to_consumer_volume_percentage":{"type":"integer","description":"Merchant's percentage of volume that is consumer to consumer (between 0 and 100)."},"other_volume_percentage":{"type":"integer","description":"The percentage of the merchant's volume that isn't represented by the previous fields (between 0 and 100)."},"person_to_person_volume_percentage":{"type":"integer","description":"The percentage the merchant's volume that's person to person (between 0 and 100)."}}},"amex_marketing_consent":{"type":"object","description":"Details about the merchant's consent to receive American Express marketing communications.","nullable":true,"properties":{"accepted":{"type":"boolean","description":"Whether the merchant accepted Amex marketing consent."},"ip_address":{"type":"string","description":"IP address of the merchant when they provided their marketing consent decision."},"user_agent":{"type":"string","description":"The browser user agent details when the merchant provided their marketing consent decision."},"timestamp":{"type":"string","description":"Timestamp of when the merchant provided their marketing consent decision (ISO 8601 format)."}}}}},"associated_entities":{"type":"array","description":[{"$$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":"entities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"associated_identities"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the user. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/createAssociatedIdentity"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an Associated Identity"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Underwriting data that's required to verify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"annual_card_volume":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The annual credit card sales (in cents) expected to be processed (max 19 characters)."},"business_address":{"type":"object","description":"The primary address for the legal entity.","nullable":true,"properties":{"city":{"type":"string","description":"City (max 20 characters).","minLength":1},"country":{"type":"string","minLength":1},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters)."},"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters)."},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters)."},"region":{"type":"string","minLength":1,"description":"2-letter state code."}}},"business_name":{"type":"string","minLength":1,"description":"Abbreviated names of the business. If there are no abbreviated name, leave this field blank.","nullable":true},"business_phone":{"type":"string","minLength":1,"description":"Customer service phone number where the merchant can be reached (max 10 characters)."},"business_tax_id":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nine digit Tax Identification Number (TIN), Employer Identification Number (EIN). If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and they do not have an EIN, use the sole proprietor's Social Security Number (SSN)."},"children":[]}]}]}]},"business_type":{"type":"string","minLength":1,"description":"Include the value that best applies to the merchant.","enum":["INDIVIDUAL_SOLE_PROPRIETORSHIP","CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","ASSOCIATION_ESTATE_TRUST","TAX_EXEMPT_ORGANIZATION","GOVERNMENT_AGENCY"]},"default_statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"dob":{"type":"object","description":"The control owner's date of birth.\n","properties":{"day":{"type":"integer"},"month":{"type":"integer"},"year":{"type":"integer"}}},"doing_business_as":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (max 60 characters)."},"children":[]}]}]}]},"email":{"type":"string","minLength":1,"description":"The email address of the principal control owner where they can be reached (max 100 characters)."},"first_name":{"type":"string","minLength":1,"description":"The legal first name of the control owner (max 20 characters)."},"has_accepted_credit_cards_previously":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not passed."},"children":[]}]}]}]},"incorporation_date":{"type":"object","description":"The date the company was founded and registered.","nullable":true,"properties":{"day":{"type":"integer","description":"Day business was incorporated (between 1 and 31)."},"month":{"type":"integer","description":"Month business was incorporated (between 1 and 12)."},"year":{"type":"integer","description":"Year business was incorporated (4-digit)."}}},"last_name":{"type":"string","minLength":1,"description":[{"$$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":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" owner's legal last name."},"children":[]}]}]}]},"max_transaction_amount":{"type":"integer","description":"The maximum amount (in cents) that can be charged for a single transaction (max 12 characters)."},"mcc":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant Category Code ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that this merchant will be classified under. For a list of approved MCCs, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/approved-merchant-category-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved Merchant Category Codes."},"children":[]}]}]}]}]},"ownership_type":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values can be 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":"code","inline":true,"attributes":{"content":"PUBLIC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate a publicly-traded company."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PRIVATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for privately-held businesses."},"children":[]}]}]}]}],"nullable":true},"personal_address":{"type":"object","description":"The home address of the principal control owner. This field is used for identity verification purposes.","properties":{"city":{"type":"string","minLength":1,"description":"City (max 20 characters)."},"country":{"type":"string","minLength":1,"description":"3-Letter country code (e.g. USA)."},"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters)."},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters)."},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters)."},"region":{"type":"string","minLength":1,"description":"2-letter State code."}}},"phone":{"type":"string","minLength":1,"description":"The principal control owner's phone number (max 10 characters)."},"principal_percentage_ownership":{"type":"integer","description":"Percentage of the company owned by the principal control owner (min 0; max 100)."},"tax_id":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided."},"children":[]}]}]}]},"title":{"type":"string","minLength":1,"description":"The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters)."},"url":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" owner's public website."},"children":[]}]}]}]}}}},"country":{"type":"string","description":"Country of the Merchant's business","enum":["USA","CAN"]},"entity":{"type":"object","description":[{"$$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":"entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" information saved in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the user."},"children":[]}]}]}],"properties":{"amex_mid":{"type":"integer","description":"Assigned amexMid value. If a value is passed, it must be 10 or 11 digits.","nullable":true},"annual_card_volume":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The annual credit card sales (in cents) expected to be processed by this seller (max 19 characters).","nullable":true},"business_address":{"type":"object","description":"The primary address for the legal entity.","nullable":true,"properties":{"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters).","nullable":true},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"city":{"type":"string","minLength":1,"description":"City (max 20 characters).","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter state code.","nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters).","nullable":true},"country":{"type":"string","minLength":1,"description":"3-Letter Country code (e.g. USA).","nullable":true}}},"business_name":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The merchant's legal business name (max 120 characters)."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"INDIVIDUAL_SOLE_PROPRIETORSHIP"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", pass the owner's legal first name, last name, and middle initial."},"children":[]}]}]}]}]}],"nullable":true},"business_phone":{"type":"string","minLength":1,"description":"Customer service phone number where the seller can be reached (max 10 characters).","nullable":true},"business_tax_id_provided":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_tax_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided."},"children":[]}]}]}]},"business_type":{"description":"Include the value that best applies to the seller.","type":"string","enum":["INDIVIDUAL_SOLE_PROPRIETORSHIP","CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","ASSOCIATION_ESTATE_TRUST","TAX_EXEMPT_ORGANIZATION","GOVERNMENT_AGENCY"],"nullable":true},"default_statement_descriptor":{"$ref":"#/components/schemas/statement_descriptor"},"discover_mid":{"description":"Assigned discoverMid value.","type":"integer","nullable":true},"dob":{"type":"object","description":"The control owner's date of birth.","nullable":true,"properties":{"day":{"type":"integer","description":"Day of birth (between 1 and 31).","minimum":1},"month":{"type":"integer","description":"Month of birth (between 1 and 12).","minimum":1},"year":{"type":"integer","description":"Year of birth (4-digit). Year must be greater than 1900.","minimum":1900}}},"doing_business_as":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternate names of the business. If there are no other names, pass the same value used for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"business_name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (max 60 characters)."},"children":[]}]}]}],"nullable":true},"email":{"type":"string","minLength":1,"description":"The email address of the principal control owner where they can be reached (max 100 characters).","nullable":true},"first_name":{"type":"string","minLength":1,"description":"The legal first name of the merchant's control owner (max 20 characters).","nullable":true},"has_accepted_credit_cards_previously":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Defaults to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"false"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if not passed."},"children":[]}]}]}]},"incorporation_date":{"type":"object","description":"The date the company was founded and registered with the US.","nullable":true,"properties":{"day":{"type":"integer","description":"Day business was incorporated (between 1 and 31)."},"month":{"type":"integer","description":"Month of birth (between 1 and 12)."},"year":{"type":"integer","description":"Year business was incorporated (4-digit)."}}},"last_name":{"type":"string","minLength":1,"description":"The legal last name of the merchant's control owner (max 20 characters).","nullable":true},"mcc":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Merchant Category Code ("},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"http://www.dm.usda.gov/procurement/card/card_x/mcc.pdf"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") that this merchant will be classified under. For a list of approved MCCs, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/managing-operations/security-compliance/approved-merchant-category-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Approved Merchant Category Codes."},"children":[]}]}]}]}],"nullable":true},"ownership_type":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Values can be either: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PUBLIC"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate a publicly-traded company."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PRIVATE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for privately-held businesses."},"children":[]}]}]}]}]}],"enum":["PUBLIC","PRIVATE"],"nullable":true},"personal_address":{"type":"object","description":"The home address of the merchant's principal control owner. This field is used for identity verification purposes.","nullable":true,"properties":{"line1":{"type":"string","minLength":1,"description":"First line of the address (max 35 characters).","nullable":true},"line2":{"type":"string","minLength":1,"description":"Second line of the address (max 35 characters).","nullable":true},"city":{"type":"string","minLength":1,"description":"City (max 20 characters).","nullable":true},"region":{"type":"string","minLength":1,"description":"2-letter State code.","nullable":true},"postal_code":{"type":"string","minLength":1,"description":"Zip or Postal code (max 7 characters).","nullable":true},"country":{"type":"string","minLength":1,"description":"3-Letter country code (e.g. USA).","nullable":true}}},"phone":{"type":"string","minLength":1,"description":"The principal control owner's phone number (max 10 characters).","nullable":true},"principal_percentage_ownership":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Percentage of the company owned by the principal control owner (min 0; max 100).","nullable":true},"short_business_name":{"type":"string","description":"Abbreviated names of the business. If there are no abbreviated name, leave this field blank.","nullable":true},"tax_authority":{"type":"string","description":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Only required when onboarding a seller with a "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"MCC"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"9311"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":"."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"code","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"tax_authority"},"children":[]}]},{"$$mdtype":"Node","type":"text","attributes":{"content":" is the tax gathering entity (e.g., San Francisco Water Authority)."},"children":[]}]}]}],"nullable":true},"tax_id":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The control owner's Social Security Number (SSN). Masked in responses (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*****3333"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"nullable":true},"tax_id_provided":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided."},"children":[]}]}]}]},"business_tax_id":{"type":"string","minLength":1,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nine digit Tax Identification Number (TIN) or Employer Identification Number (EIN). Masked in responses (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*****2222"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"nullable":true},"title":{"type":"string","minLength":1,"description":"The corporate title of the control owner (e.g. Chief Executive Officer, CFO, etc. Max 60 characters).","nullable":true},"url":{"type":"string","minLength":1,"description":"The URL of the merchant's public website.","nullable":true}}},"payment_instruments":{"type":"object","description":[{"$$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":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that'll be used to payout the seller. For more information, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/payouts/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payouts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"account_number":{"type":"string","description":"The bank account number (no dashes in between numbers). Canadian bank account numbers cannot exceed 15 characters."},"account_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of bank account. Use the following respective enum when creating a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"ul","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CHECKING: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The checking account of your buyer."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"SAVINGS: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The savings account of your buyer."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORPORATE: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A corporate checking account."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CORP_SAVINGS: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A corporate savings account."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS_CHECKING: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A checking account primarily owned by a business."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BUSINESS_SAVINGS: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A savings account primarily owned by a business"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL_CHECKING: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seller's using their personal checking account."},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"li","attrs":{}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"strong","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PERSONAL_SAVINGS: "},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Seller's using their personal savings account."},"children":[]}]}]}]}]}]},"attempt_bank_account_validation_check":{"enum":["CHECKING","SAVINGS","PERSONAL_CHECKING","PERSONAL_SAVINGS","BUSINESS_CHECKING","BUSINESS_SAVINGS","CORPORATE","CORP_SAVINGS"]},"bank_code":{"type":"string","description":"The routing number of the bank account."},"name":{"type":"string","description":"The name of the bank account owner."},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["BANK_ACCOUNT"]},"country":{"type":"string","description":"3-letter country code for the bank account (e.g., USA, CAN)."},"currency":{"type":"string","description":"3-letter ISO currency code for the bank account (e.g., USD, CAD)."}}},"max_transaction_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum card amount that can be transacted for a single transaction in cents (max 12 characters). Must be equal to or less than your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max_transaction_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"ach_max_transaction_amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum ACH amount that can be transacted for a single transaction in cents (max 12 characters). Must be equal to or less than your "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ach_max_transaction_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"associated_files":{"type":"array","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Files"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Files"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" your user uploaded inside their Onboarding Form."},"children":[]}]}]}],"items":{"type":"object","properties":{"type":{"description":[{"$$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":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the File."},"children":[]}]}]}],"type":"string"},"name":{"description":"The name of the File.","type":"string"},"id":{"description":[{"$$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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the File."},"children":[]}]}]}],"type":"string"},"related_to":{"description":[{"$$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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the resource the File is linked to."},"children":[]}]}]}],"type":"string"}}},"default":[]}},"required":["max_transaction_amount"]}},"components/schemas/onboarding_link_details":{"id":"components/schemas/onboarding_link_details","kind":"json-schema","title":"onboarding_link_details","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information of the initial onboarding link. This is only provided when creating an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onboarding_form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"expiration_in_minutes":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration (in minutes) the link is valid. Sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response. Defaults to 60 minutes."},"children":[]}]}]}]},"expired_session_url":{"type":"string","description":"The URL users get sent to if the bearer token expires."},"fee_details_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the page where you display the fees related to processing payments (for more info, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-forms/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Onboarding Forms"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"merchant_max_transaction_amount":{"type":"integer","description":"The maximum transaction amount for the merchant's card payment processing."},"merchant_ach_max_transaction_amount":{"type":"integer","description":"The maximum transaction amount for the merchant's ACH payment processing."},"return_url":{"type":"string","description":"The URL users get sent to after completing the onboarding flow."},"terms_of_service_url":{"type":"string","description":"Your Terms of Service URL. The URL is provided to users for consent along with Finix's Terms of Service."}},"required":["expired_session_url","fee_details_url","return_url","terms_of_service_url"]}},"components/schemas/createOnboardingForm":{"id":"components/schemas/createOnboardingForm","kind":"json-schema","title":"createOnboardingForm","data":{"type":"object","properties":{"merchant_processors":{"type":"array","description":"An array of objects with the processors and gateways users will be onboarded to.","items":{"type":"object","properties":{"processor":{"type":"string","description":"The name of the processor you plan to onboard users to."}},"required":["processor"]}},"onboarding_data":{"$ref":"#/components/schemas/onboarding_data"},"onboarding_link_details":{"$ref":"#/components/schemas/onboarding_link_details"},"tags":{"$ref":"#/components/schemas/tags"}},"required":["merchant_processors","onboarding_data","onboarding_link_details"]}},"components/schemas/createOnboardingFormUSAMinimal":{"id":"components/schemas/createOnboardingFormUSAMinimal","kind":"json-schema","title":"Onboarding Form - USA - Minimal Fields","data":{"title":"Onboarding Form - USA - Minimal Fields","allOf":[{"$ref":"#/components/schemas/createOnboardingForm"}]}},"components/schemas/createOnboardingFormUSAAllFields":{"id":"components/schemas/createOnboardingFormUSAAllFields","kind":"json-schema","title":"Onboarding Form - USA - All Fields","data":{"title":"Onboarding Form - USA - All Fields","allOf":[{"$ref":"#/components/schemas/createOnboardingForm"}]}},"components/schemas/createOnboardingFormCANMinimal":{"id":"components/schemas/createOnboardingFormCANMinimal","kind":"json-schema","title":"Onboarding Form - CAN - Minimal Fields","data":{"title":"Onboarding Form - CAN - Minimal Fields","allOf":[{"$ref":"#/components/schemas/createOnboardingForm"}]}},"components/schemas/createOnboardingFormCANAllFields":{"id":"components/schemas/createOnboardingFormCANAllFields","kind":"json-schema","title":"Onboarding Form - CAN - All Fields","data":{"title":"Onboarding Form - CAN - All Fields","allOf":[{"$ref":"#/components/schemas/createOnboardingForm"}]}},"components/schemas/onboarding_link":{"id":"components/schemas/onboarding_link","kind":"json-schema","title":"onboarding_link","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The information of the initial onboarding link. This is only provided when creating an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onboarding_form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"expires_at":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A UTC timestamp detailing when the onboarding form expires and will no longer be available via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". To generate a new link to the same form, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/platform-payments/onboarding-sellers/seller-onboarding-forms/#fetching-an-onboarding-form-link"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get an Onboarding Form URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"link_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The URL of the user's Finix Onboarding Form. Users can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"link_url"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return to the form until the link expires."},"children":[]}]}]}]}}}},"components/schemas/onboarding_form":{"id":"components/schemas/onboarding_form","kind":"json-schema","title":"onboarding_form","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"onboarding_data":{"$ref":"#/components/schemas/onboarding_data"},"merchant_processors":{"type":"array","description":"An array of objects with the processors and gateways users will be onboarded to.","items":{"type":"object","properties":{"processor":{"type":"string","description":"The name of the processor you plan to onboard users to."}}}},"onboarding_link_details":{"$ref":"#/components/schemas/onboarding_link_details"},"onboarding_link":{"$ref":"#/components/schemas/onboarding_link"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Status of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onboarding_form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["IN_PROGRESS","COMPLETED","UPDATE_REQUESTED"]},"identity_id":{"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":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource. This is only provided when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"onboarding_form"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"application_id":{"$ref":"#/components/schemas/application_id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/createOnboardingLink":{"id":"components/schemas/createOnboardingLink","kind":"json-schema","title":"Onboarding Form Link","data":{"title":"Onboarding Form Link","allOf":[{"$ref":"#/components/schemas/onboarding_link_details"}]}},"components/schemas/submitDisputeEvidence":{"id":"components/schemas/submitDisputeEvidence","kind":"json-schema","title":"submitDisputeEvidence","data":{"type":"object","properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enter the amount in cents for the partial dispute you wish to rebut. Use this field only if you are rebutting part of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The amount must be equal to or less than the disputed amount. If you use this field, provide details in the notes explaining the reason for the partial amount."},"children":[]}]}]}],"nullable":true},"note":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include a note to explain the evidence files and the rebuttal of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Partial rebuttal is due to double charging cardholder due to technical malfunction on point of sale, but we have attached receipt as proof that cardhoder received item."},"refund":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use this field only if you are resolving an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INQUIRY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" dispute with a proactive refund to the cardholder, or if a refund was made before the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" but the cardholder did not notice. The value should be the ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource must be in state "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUCCEEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVERSAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or one of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operation_key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"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":"UNREFERENCED_REFUND"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_NOT_PRESENT_UNREFERENCED_REFUND"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CARD_PRESENT_UNREFERENCED_REFUND"},"children":[]}]}]}]}],"example":"TRxxxxxxxxx","nullable":true}},"required":["note"]}},"components/schemas/acceptDispute":{"id":"components/schemas/acceptDispute","kind":"json-schema","title":"acceptDispute","data":{"type":"object","properties":{"note":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include a note or custom metadata to reference the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"Accepting Dispute: Mistaken Charge"}},"required":["note"]}},"components/schemas/split_transfer":{"id":"components/schemas/split_transfer","kind":"json-schema","title":"split_transfer","data":{"type":"object","description":[{"$$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":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that was created from a split transacion."},"children":[]}]}]}],"properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"fee":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The minimum amount of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you'd like to collect as your fee in cents. Defaults to zero (must be less than or equal to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"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":"text","inline":true,"attributes":{"content":"If the fees applied by the 'Fee Profile' are "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"higher"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than the value passed in 'fee', 'fee' will not be applied and have no effect."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the fees applied by the 'Fee Profile' are "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"lower"},"children":[]}]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" than the value passed in 'fee', an additional fee is be applied, in addition to the fees generated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"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":"text","inline":true,"attributes":{"content":"The additional fee is equal to the difference between the value passed in 'fee' and the fees generated by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]}],"format":"int64"},"currency":{"$ref":"#/components/schemas/currency"},"parent_transfer_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the original parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was split."},"children":[]}]}]}],"example":"TR7h8NxhCDHunLFdJ1HCLp4r"},"ready_to_settle_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The timestamp of when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ready to be settled."},"children":[]}]}]}],"nullable":true},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"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":"DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Standard "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from a split transaction where the parent "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" debits the buyer's card."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISPUTE_MERCHANT_DEBIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/disputes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dispute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" pulls funds from merchants proportionally. Created when the parent "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/disputes/listdisputesadjustments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"adjustment transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: DISPUTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subtype: MERCHANT_DEBIT"},"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":"code","inline":true,"attributes":{"content":"DISPUTE_MERCHANT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created when a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dispute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is ruled in favor of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and funds are returned proportionally. Created when the parent adjustment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: DISPUTE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subtype: MERCHANT_CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["DEBIT","DISPUTE_MERCHANT_DEBIT","DISPUTE_MERCHANT_CREDIT"]},"merchant_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created for and will settle under."},"children":[]}]}]}]},"identity_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource used by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created for."},"children":[]}]}]}]},"fee_profile_id":{"type":"string","description":[{"$$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":"Fee Profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"application_id":{"$ref":"#/components/schemas/application_id"},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"self":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link to this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Split Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource."},"children":[]}]}]}],"properties":{"href":{"type":"string"}}}}}}}},"components/schemas/billing_cycle_day":{"id":"components/schemas/billing_cycle_day","kind":"json-schema","title":"billing_cycle_day","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day of the month on which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is billed. Only applies to subscriptions with a monthly billing cycle (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MONTHLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIMONTHLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUARTERLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEMIYEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIYEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRIYEARLY"},"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 specified day doesn't exist in a given month (e.g., April 31), the subscription is billed on the last valid day of that month."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accepted values are 1 to 31."},"children":[]}]}]}],"minimum":1,"maximum":31,"example":1,"nullable":true}},"components/schemas/billing_interval":{"id":"components/schemas/billing_interval","kind":"json-schema","title":"billing_interval","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How often the buyer is billed. The possible billing intervals are as follows:"},"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":"BIMONTHLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every 2 months"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIWEEKLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every 2 weeks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BIYEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every 2 years"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DAILY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every day"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MONTHLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every month"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"QUARTERLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": each quarter"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SEMIYEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": twice a year"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRIYEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every 3 years"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WEEKLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every week"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YEARLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": every year"},"children":[]}]}]}]}],"example":"MONTHLY","enum":["BIMONTHLY","BIWEEKLY","BIYEARLY","DAILY","MONTHLY","QUARTERLY","SEMIYEARLY","TRIYEARLY","WEEKLY","YEARLY"]}},"components/schemas/nickname":{"id":"components/schemas/nickname","kind":"json-schema","title":"nickname","data":{"type":"string","description":"A human-readable name for the resource.","nullable":true}},"components/schemas/subscription":{"id":"components/schemas/subscription","kind":"json-schema","title":"Subscription","data":{"title":"Subscription","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"application_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Application"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"billing_cycle_day":{"$ref":"#/components/schemas/billing_cycle_day"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}]},"requested_delivery_methods":{"$ref":"#/components/schemas/receipt_requested_delivery_methods"},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/address"}],"nullable":true}}},"canceled_via":{"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":"If the subscription was canceled, this field shows how the cancellation was initiated."},"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":"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":"MERCHANT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The customer (merchant) canceled the subscription themselves. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field indicates the related "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"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":"code","inline":true,"attributes":{"content":"AUTOMATED_OVERDUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The subscription was canceled by the overdue system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The subscription was canceled by Finix Support."},"children":[]}]}]}]}],"enum":["MERCHANT","AUTOMATED_OVERDUE","SUPPORT"]},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["USD","CAD"]},"end_subscription_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of when the subscription ends. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was included in the request, this field echoes that value. If only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was provided, this field is calculated to match the last day of the final billing cycle."},"children":[]}]}]}]},"expires_at":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date-time that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expires. Set when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, this field mirrors that value."},"children":[]}]}]}]},"first_charge_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp when the first "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will occur."},"children":[]}]}]}]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}]},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["MERCHANT"]},"next_billing_date":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Details when the next "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/transfers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transfer"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will occur."},"children":[]}]}]}],"properties":{"year":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The year the next "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will occur."},"children":[]}]}]}]},"month":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The month the next "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will occur."},"children":[]}]}]}]},"day":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day the next "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Transfer"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will occur."},"children":[]}]}]}]}}},"nickname":{"$ref":"#/components/schemas/nickname"},"start_subscription_at":{"type":"string","format":"date-time","description":"Indicates that the subscription is scheduled to begin in the future. The timestamp specifies the exact start date for subscription billing."},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"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":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NOT_STARTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state occurs when the subscription has not yet started, typically indicated by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp set during creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A subscription in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PAST_DUE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state is unpaid but has not yet been canceled."},"children":[]}]}]}]}],"enum":["ACTIVE","CANCELED","EXPIRED","NOT_STARTED","PAST_DUE"]},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatic billing of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only available method."},"children":[]}]}]}],"enum":["BILL_AUTOMATICALLY"]},"send_invoice":{"type":"boolean","description":"Whether to send the user an invoice."},"send_receipt":{"type":"boolean","description":"Whether to send the user a receipt."},"trial_details":{"type":"object","nullable":true,"description":"Object containing trial details.","properties":{"interval_type":{"type":"string","description":"The unit of time for the trial period.","enum":["DAY","WEEK","MONTH","YEAR"]},"interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of intervals of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to describe the duration of the trial."},"children":[]}]}]}]},"trial_started_at":{"type":"string","format":"date-time","description":"A timestamp indicating when the trial period began.","nullable":true},"trial_expected_start_at":{"type":"string","format":"date-time","description":"A timestamp indicating when the trial period is expected to start."},"trial_expected_end_at":{"type":"string","format":"date-time","description":"A timestamp indicating when the trial period ends."}}},"discount_phase_details":{"type":"object","nullable":true,"description":"Object containing discount phase details.","properties":{"amount":{"type":"integer","description":"The discounted amount (in cents) that the buyer is charged during the discount phase."},"billing_interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of billing intervals the discount applies. After this period, the buyer is charged the full "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"discount_phase_started_at":{"type":"string","format":"date-time","description":"A timestamp indicating when the discount phase began.","nullable":true},"discount_phase_expected_start_at":{"type":"string","format":"date-time","description":"A timestamp indicating when the discount phase is expected to start."},"discount_phase_expected_end_at":{"type":"string","format":"date-time","description":"A timestamp indicating when the discount phase is expected to end."}}},"notification_preferences":{"type":"object","description":"Object containing notification preferences.","properties":{"send_confirmation":{"type":"boolean","description":"Whether to send a confirmation email to the user.","default":false}}}},"required":["collection_method"]},"subscription_link_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that created the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"subscription_phase":{"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 period within a subscription where specific rules apply."},"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":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The buyer is billed continuously for the subscription until the subscription is canceled."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The buyer receives a discounted price for a limited billing interval, after which the customer is charged the full subscription amount."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIXED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state - Applicable to fixed-length subscriptions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NONE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Indicates that when the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" timestamp is set during subscription creation, the subscription is not yet in any phase, and billing has not started."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TRIAL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - The period during which the buyer is not billed; after this phase, the buyer will begin being billed."},"children":[]}]}]}]}],"enum":["EVERGREEN","DISCOUNT","FIXED","NONE","TRIAL"]},"subscription_plan_id":{"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":"The ID of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was created. When provided, the plan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and other defaults are inherited."},"children":[]}]}]}],"example":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"},"has_usage_based_plan":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is associated with a usage-based "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true},"tags":{"$ref":"#/components/schemas/tags"},"total_billing_intervals":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of billing intervals for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This represents the total count of recurring billing cycles, such as months or weeks, depending on the billing frequency."},"children":[]}]}]}]},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"self":{"$ref":"#/components/schemas/self"}}}}}},"components/schemas/createSubscriptionMinimalFields":{"id":"components/schemas/createSubscriptionMinimalFields","kind":"json-schema","title":"Subscription - Minimal Fields","data":{"title":"Subscription - Minimal Fields","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}],"example":"IDtEnKsZyJNUGK83ZTx4C45S"},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}],"example":"PImXAVgkKVshKWWHUk4xXbve"}},"required":["identity_id","instrument_id"]},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatically billing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only method available."},"children":[]}]}]}],"example":"BILL_AUTOMATICALLY","enum":["BILL_AUTOMATICALLY"]}},"required":["collection_method"]}},"required":["amount","buyer_details","currency","linked_to","linked_type","billing_interval","subscription_details"]}},"components/schemas/end_subscription_at":{"id":"components/schemas/end_subscription_at","kind":"json-schema","title":"end_subscription_at","data":{"type":"string","format":"date-time","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamp of when the subscription ends. Applies to fixed amount subscriptions only."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finix prorates the final charge if the subscription ends mid-billing-cycle. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" falls on a cycle boundary, the final charge is not prorated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following rules apply:"},"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":"Cannot be used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the same request."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be after the subscription start."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be after the free trial period."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be after the discounted phase."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be updated after the subscription is created."},"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":"Relationship with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"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":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response is calculated as the number of started cycles needed to reach the end date."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response is calculated to match the last day of the final cycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the same value in the response."},"children":[]}]}]}]}]}},"components/schemas/total_billing_intervals":{"id":"components/schemas/total_billing_intervals","kind":"json-schema","title":"total_billing_intervals","data":{"type":"integer","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of billing cycles for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Cannot be used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the same request and cannot be updated after the subscription is created."},"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":"Relationship with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"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":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response is calculated to match the last day of the final cycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"end_subscription_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response is calculated as the number of started cycles needed to reach the end date."},"children":[]}]}]}]}],"example":12}},"components/schemas/createSubscription":{"id":"components/schemas/createSubscription","kind":"json-schema","title":"Subscription - All Fields","data":{"title":"Subscription - All Fields","type":"object","properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). You cannot set the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field when you use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":5000,"format":"int64"},"billing_cycle_day":{"$ref":"#/components/schemas/billing_cycle_day"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}],"example":"IDtEnKsZyJNUGK83ZTx4C45S"},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}],"example":"PImXAVgkKVshKWWHUk4xXbve"},"requested_delivery_methods":{"$ref":"#/components/schemas/receipt_requested_delivery_methods"},"shipping_address":{"$ref":"#/components/schemas/address"}},"required":["identity_id","instrument_id"]},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"end_subscription_at":{"$ref":"#/components/schemas/end_subscription_at"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"nickname":{"$ref":"#/components/schemas/nickname"},"start_subscription_at":{"type":"string","format":"date-time","description":"Indicates that the subscription is scheduled to begin in the future. The timestamp specifies the exact start date for subscription billing.","example":"2029-05-05T22:42:05.490Z"},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatic billing of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only available method."},"children":[]}]}]}],"example":"BILL_AUTOMATICALLY","enum":["BILL_AUTOMATICALLY"]},"discount_phase_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing discount phase details. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is based on a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"discount_phase_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not override the plan's values."},"children":[]}]}]}],"properties":{"amount":{"type":"integer","description":"The discounted amount (in cents) that the buyer is charged during the discount phase."},"billing_interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of billing intervals the discount applies. After this period, the buyer is charged the full "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":3}},"required":["amount","billing_interval_count"]},"notification_preferences":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing notification preferences. At least one "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"buyer_details.requested_delivery_method"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required if notification preferences are set."},"children":[]}]}]}],"properties":{"send_confirmation":{"type":"boolean","description":"Whether to send a confirmation email to the user.","example":true}}},"send_invoice":{"type":"boolean","description":"Whether to send the user an invoice."},"send_receipt":{"type":"boolean","description":"Whether to send the user a receipt."},"trial_details":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Object containing trial details. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is based on a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trial_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" do not override those from the plan."},"children":[]}]}]}],"properties":{"interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of intervals of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to describe the duration of the trial."},"children":[]}]}]}],"example":2},"interval_type":{"type":"string","description":"The unit of time for the trial period.","example":"MONTH","enum":["DAY","MONTH","WEEK","YEAR"]}},"required":["interval_type","interval_count"]}},"required":["collection_method"]},"subscription_plan_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/subscription-plans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to base this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on. When provided, the plan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and other defaults are inherited."},"children":[]}]}]}],"example":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"},"tags":{"$ref":"#/components/schemas/tags"},"total_billing_intervals":{"$ref":"#/components/schemas/total_billing_intervals"}},"required":["amount","buyer_details","currency","linked_to","linked_type","billing_interval","subscription_details"]}},"components/schemas/createSubscriptionBillingCycleDay":{"id":"components/schemas/createSubscriptionBillingCycleDay","kind":"json-schema","title":"Subscription - Billing Cycle Day","data":{"title":"Subscription - Billing Cycle Day","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_cycle_day":{"$ref":"#/components/schemas/billing_cycle_day"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}],"example":"IDtEnKsZyJNUGK83ZTx4C45S"},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}],"example":"PImXAVgkKVshKWWHUk4xXbve"}},"required":["identity_id","instrument_id"]},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatic billing of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only available method."},"children":[]}]}]}],"example":"BILL_AUTOMATICALLY","enum":["BILL_AUTOMATICALLY"]}},"required":["collection_method"]}},"required":["amount","billing_interval","buyer_details","currency","linked_to","linked_type","subscription_details"]}},"components/schemas/createSubscriptionDiscountPhase":{"id":"components/schemas/createSubscriptionDiscountPhase","kind":"json-schema","title":"Subscription - Discount Phase","data":{"title":"Subscription - Discount Phase","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments get debited."},"children":[]}]}]}]}}},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatically billing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only method available."},"children":[]}]}]}],"example":"BILL_AUTOMATICALLY","enum":["BILL_AUTOMATICALLY"]},"discount_phase_details":{"type":"object","description":"Object containing discount phase details.","properties":{"amount":{"type":"integer","description":"The discounted amount (in cents) that the buyer is charged during the discount phase."},"billing_interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of billing intervals the discount applies. After this period, the buyer is charged the full "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"required":["collection_method"]}},"required":["amount","billing_interval","buyer_details","currency","linked_to","linked_type","subscription_details"]}},"components/schemas/createSubscriptionFixed":{"id":"components/schemas/createSubscriptionFixed","kind":"json-schema","title":"Subscription - Fixed-Length","data":{"title":"Subscription - Fixed-Length","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments get debited."},"children":[]}]}]}]}}},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatically billing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only method available."},"children":[]}]}]}],"example":"BILL_AUTOMATICALLY","enum":["BILL_AUTOMATICALLY"]}},"required":["collection_method"]},"total_billing_intervals":{"$ref":"#/components/schemas/total_billing_intervals"}},"required":["amount","billing_interval","buyer_details","currency","linked_to","linked_type","subscription_details"]}},"components/schemas/createSubscriptionFixedEndDate":{"id":"components/schemas/createSubscriptionFixedEndDate","kind":"json-schema","title":"Subscription - Fixed-Length - End Date","data":{"title":"Subscription - Fixed-Length - End Date","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments get debited."},"children":[]}]}]}]}}},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"end_subscription_at":{"$ref":"#/components/schemas/end_subscription_at"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatically billing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only method available."},"children":[]}]}]}],"example":"BILL_AUTOMATICALLY","enum":["BILL_AUTOMATICALLY"]}},"required":["collection_method"]}},"required":["amount","billing_interval","buyer_details","currency","linked_to","linked_type","subscription_details"]}},"components/schemas/createSubscriptionFuture":{"id":"components/schemas/createSubscriptionFuture","kind":"json-schema","title":"Subscription - Future Start Date","data":{"title":"Subscription - Future Start Date","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments get debited."},"children":[]}]}]}]}}},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"start_subscription_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is scheduled to begin in the future. The timestamp specifies the exact start date for subscription billing."},"children":[]}]}]}]},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatically billing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only method available."},"children":[]}]}]}],"example":"BILL_AUTOMATICALLY","enum":["BILL_AUTOMATICALLY"]}},"required":["collection_method"]}},"required":["amount","billing_interval","buyer_details","currency","linked_to","linked_type","subscription_details"]}},"components/schemas/createSubscriptionTrial":{"id":"components/schemas/createSubscriptionTrial","kind":"json-schema","title":"Subscription - Trial Period","data":{"title":"Subscription - Trial Period","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" payments get debited."},"children":[]}]}]}]}}},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["CAD","USD"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. Currently, automatically billing the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the only method available."},"children":[]}]}]}],"example":"BILL_AUTOMATICALLY","enum":["BILL_AUTOMATICALLY"]},"trial_details":{"type":"object","description":"Object containing trial details.","properties":{"interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of intervals of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to describe the duration of the trial."},"children":[]}]}]}],"example":2},"interval_type":{"type":"string","description":"The unit of time for the trial period.","example":"MONTH","enum":["DAY","MONTH","WEEK","YEAR"]}},"required":["interval_type","interval_count"]}},"required":["collection_method"]}},"required":["amount","billing_interval","buyer_details","currency","linked_to","linked_type","subscription_details"]}},"components/schemas/createSubscriptionFromPlanMinimalFields":{"id":"components/schemas/createSubscriptionFromPlanMinimalFields","kind":"json-schema","title":"Subscription - Subscription Plan - Minimal Fields","data":{"title":"Subscription - Subscription Plan - Minimal Fields","type":"object","properties":{"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}],"example":"IDtEnKsZyJNUGK83ZTx4C45S"},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}],"example":"PImXAVgkKVshKWWHUk4xXbve"}},"required":["identity_id","instrument_id"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUxdJCr9xTMnmt1vGUAqV9z4"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_plan_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"}},"required":["buyer_details","linked_to","linked_type","subscription_plan_id"]}},"components/schemas/createSubscriptionFromPlan":{"id":"components/schemas/createSubscriptionFromPlan","kind":"json-schema","title":"Subscription - Subscription Plan - All Fields","data":{"title":"Subscription - Subscription Plan - All Fields","properties":{"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}],"example":"IDtEnKsZyJNUGK83ZTx4C45S"},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}],"example":"PImXAVgkKVshKWWHUk4xXbve"},"requested_delivery_methods":{"$ref":"#/components/schemas/receipt_requested_delivery_methods"},"shipping_address":{"$ref":"#/components/schemas/address"}},"required":["identity_id","instrument_id"]},"end_subscription_at":{"$ref":"#/components/schemas/end_subscription_at"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUxdJCr9xTMnmt1vGUAqV9z4"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"nickname":{"$ref":"#/components/schemas/nickname"},"start_subscription_at":{"type":"string","format":"date-time","description":"Indicates that the subscription is scheduled to begin in the future. The timestamp specifies the exact start date for subscription billing.","example":"2029-05-05T22:42:05.490Z"},"subscription_plan_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"},"tags":{"$ref":"#/components/schemas/tags"},"total_billing_intervals":{"$ref":"#/components/schemas/total_billing_intervals"}},"required":["buyer_details","linked_to","linked_type","subscription_plan_id"]}},"components/schemas/createSubscriptionFromPlanFixed":{"id":"components/schemas/createSubscriptionFromPlanFixed","kind":"json-schema","title":"Subscription - Subscription Plan - Fixed-Length","data":{"title":"Subscription - Subscription Plan - Fixed-Length","type":"object","properties":{"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}],"example":"IDtEnKsZyJNUGK83ZTx4C45S"},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}],"example":"PImXAVgkKVshKWWHUk4xXbve"}},"required":["identity_id","instrument_id"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUxdJCr9xTMnmt1vGUAqV9z4"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_plan_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"},"total_billing_intervals":{"$ref":"#/components/schemas/total_billing_intervals"}},"required":["buyer_details","linked_to","linked_type","subscription_plan_id"]}},"components/schemas/createSubscriptionFromPlanFixedEndDate":{"id":"components/schemas/createSubscriptionFromPlanFixedEndDate","kind":"json-schema","title":"Subscription - Subscription Plan - Fixed-Length - End Date","data":{"title":"Subscription - Subscription Plan - Fixed-Length - End Date","type":"object","properties":{"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}],"example":"IDtEnKsZyJNUGK83ZTx4C45S"},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}],"example":"PImXAVgkKVshKWWHUk4xXbve"}},"required":["identity_id","instrument_id"]},"end_subscription_at":{"$ref":"#/components/schemas/end_subscription_at"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUxdJCr9xTMnmt1vGUAqV9z4"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"subscription_plan_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"}},"required":["buyer_details","linked_to","linked_type","subscription_plan_id"]}},"components/schemas/createSubscriptionFromPlanFuture":{"id":"components/schemas/createSubscriptionFromPlanFuture","kind":"json-schema","title":"Subscription - Subscription Plan - Future Start Date","data":{"title":"Subscription - Subscription Plan - Future Start Date","type":"object","properties":{"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}],"example":"IDtEnKsZyJNUGK83ZTx4C45S"},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}],"example":"PImXAVgkKVshKWWHUk4xXbve"}},"required":["identity_id","instrument_id"]},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/merchants"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}],"example":"MUxdJCr9xTMnmt1vGUAqV9z4"},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"example":"MERCHANT","enum":["MERCHANT"]},"start_subscription_at":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates that the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is scheduled to begin in the future. The timestamp specifies the exact start date for subscription billing."},"children":[]}]}]}]},"subscription_plan_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which to create the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"}},"required":["buyer_details","linked_to","linked_type","subscription_plan_id"]}},"components/schemas/updateSubscription":{"id":"components/schemas/updateSubscription","kind":"json-schema","title":"Update Subscription","data":{"title":"Update Subscription","type":"object","properties":{"amount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). This field can be updated only for subscriptions "},"children":[]},{"$$mdtype":"Node","type":"em","inline":true,"attributes":{"marker":"*"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" created from subscription plans."},"children":[]}]}]}],"format":"int64"},"billing_cycle_day":{"$ref":"#/components/schemas/billing_cycle_day"},"buyer_details":{"type":"object","description":"An object containing details about the buyer.","properties":{"identity_id":{"type":"string","description":[{"$$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":"link","inline":true,"attributes":{"href":"/api/identities"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"identity ID"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the buyer."},"children":[]}]}]}]},"instrument_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api/payment-instruments"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Payment Instrument"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from which the subscription payments get debited."},"children":[]}]}]}]},"requested_delivery_methods":{"$ref":"#/components/schemas/receipt_requested_delivery_methods"},"shipping_address":{"allOf":[{"$ref":"#/components/schemas/address"}],"nullable":true}}},"nickname":{"$ref":"#/components/schemas/nickname"},"subscription_details":{"type":"object","description":"An object containing subscription details.","properties":{"send_invoice":{"type":"boolean","description":"Whether to send the user an invoice."},"send_receipt":{"type":"boolean","description":"Whether to send the user a receipt."}}},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/updateSubscriptionBillingCycleDay":{"id":"components/schemas/updateSubscriptionBillingCycleDay","kind":"json-schema","title":"Update Subscription - Billing Cycle Day","data":{"title":"Update Subscription - Billing Cycle Day","type":"object","properties":{"billing_cycle_day":{"$ref":"#/components/schemas/billing_cycle_day"}}}},"components/schemas/updateSubscriptionNewPlan":{"id":"components/schemas/updateSubscriptionNewPlan","kind":"json-schema","title":"Update Subscription - New Subscription Plan","data":{"title":"Update Subscription - New Subscription Plan","type":"object","properties":{"subscription_plan_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on which the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is based."},"children":[]}]}]}]}}}},"components/schemas/subscription_balance_entry":{"id":"components/schemas/subscription_balance_entry","kind":"json-schema","title":"Subscription Balance Entry","data":{"title":"Subscription Balance Entry","type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 3-letter currency code. Currently, the only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["USD"]},"description":{"type":"string","description":"Describes the circumstances for the subscription credit."},"subscription_id":{"type":"string","description":[{"$$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":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was credited."},"children":[]}]}]}]},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value of this field will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/createSubscriptionBalanceEntry":{"id":"components/schemas/createSubscriptionBalanceEntry","kind":"json-schema","title":"Subscription Balance Entry","data":{"title":"Subscription Balance Entry","type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 3-letter currency code. Currently, the only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["USD"]},"description":{"type":"string","description":"A description of the reason for the subscription credit. Does not support special characters."},"tags":{"$ref":"#/components/schemas/tags"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Will always be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CREDIT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["CREDIT"]}},"required":["type"]}},"components/schemas/updateSubscriptionBalanceEntry":{"id":"components/schemas/updateSubscriptionBalanceEntry","kind":"json-schema","title":"Update Subscription Balance Entry","data":{"title":"Update Subscription Balance Entry","type":"object","properties":{"tags":{"$ref":"#/components/schemas/tags"}}}},"components/schemas/default_total_billing_intervals":{"id":"components/schemas/default_total_billing_intervals","kind":"json-schema","title":"default_total_billing_intervals","data":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of billing intervals for subscriptions created from this plan. This is the count of recurring billing cycles, with the interval unit defined by the plan’s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", such as weekly, monthly, etc. If included, the plan’s "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIXED_TERM"},"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":"Subscriptions created with this plan will use the default duration in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The subscription's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expires_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field will be set to the datetime when the subscription expires based on the plan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default_total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true}},"components/schemas/subscription_plan":{"id":"components/schemas/subscription_plan","kind":"json-schema","title":"subscription_plan","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/id"},"created_at":{"$ref":"#/components/schemas/created_at"},"updated_at":{"$ref":"#/components/schemas/updated_at"},"application_id":{"$ref":"#/components/schemas/application_id"},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Merchants"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription plan belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}]},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["MERCHANT"]},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"nickname":{"$ref":"#/components/schemas/nickname"},"plan_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-friendly name for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"amount":{"$ref":"#/components/schemas/amount"},"currency":{"type":"string","description":"ISO 4217 3-letter currency code.","enum":["USD","CAD"]},"default_total_billing_intervals":{"$ref":"#/components/schemas/default_total_billing_intervals"},"duration_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether subscriptions created from this plan will have a fixed term or will continue until canceled. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default_total_billing_intervals"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, this plan's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is automatically set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FIXED_TERM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Otherwise, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"duration_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EVERGREEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["FIXED_TERM","EVERGREEN"],"nullable":true},"billing_defaults":{"type":"object","description":"Object containing default billing settings.","properties":{"collection_method":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The method by which subscription payments are collected. At this time, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BILL_AUTOMATICALLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}],"enum":["BILL_AUTOMATICALLY"]},"send_invoice":{"type":"boolean","description":"This feature has yet to be implemented."},"send_receipt":{"type":"boolean","description":"This feature has yet to be implemented."}}},"trial_defaults":{"type":"object","nullable":true,"description":"Object containing default trial settings.","properties":{"interval_type":{"type":"string","description":"The unit of time for the trial period.","enum":["DAY","WEEK","MONTH","YEAR"]},"interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of intervals of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to describe the duration of the trial."},"children":[]}]}]}]}}},"discount_phase_defaults":{"type":"object","nullable":true,"properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of billing intervals the discount applies. After this period, the subscriber is charged the full "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"is_usage_based":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is usage-based."},"children":[]}]}]}],"nullable":true},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ACTIVE","INACTIVE"]},"billing_items":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of billing items associated with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"items":{"type":"object"}},"tags":{"$ref":"#/components/schemas/tags"},"_links":{"type":"object","description":"An object containing link(s) relevant to the request. You can store these links for follow-up requests.","properties":{"self":{"$ref":"#/components/schemas/self"}}}}}},"components/schemas/createSubscriptionPlan":{"id":"components/schemas/createSubscriptionPlan","kind":"json-schema","title":"createSubscriptionPlan","data":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_defaults":{"type":"object","description":"Object containing default billing settings.","properties":{"collection_method":{"type":"string","description":"The method by which subscription payments are collected.","enum":["ACH","BILL_AUTOMATICALLY"]}},"required":["collection_method"]},"billing_interval":{"$ref":"#/components/schemas/billing_interval"},"currency":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 4217 3-letter currency code. Currently, the only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currency"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" supported is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["USD"]},"default_total_billing_intervals":{"$ref":"#/components/schemas/default_total_billing_intervals"},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"discount_phase_defaults":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"billing_interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of billing intervals the discount applies. After this period, the subscriber is charged the full "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"linked_to":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#Merchants"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Merchant"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource that you wish to link to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (i.e., the merchant that the subscription plan belongs to)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At this time, only approved merchants with one of the following processors are valid:"},"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":"DUMMY_V1"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FINIX_V1"},"children":[]}]}]}]}]},"linked_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the resource that is specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"linked_to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]}],"enum":["MERCHANT"]},"nickname":{"$ref":"#/components/schemas/nickname"},"plan_name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A human-friendly name for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"tags":{"$ref":"#/components/schemas/tags"},"trial_defaults":{"type":"object","description":"Object containing default trial settings.","properties":{"interval_count":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of intervals of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" used to describe the duration of the trial."},"children":[]}]}]}]},"interval_type":{"type":"string","description":"The unit of time for the trial period.","enum":["DAY","MONTH","WEEK","YEAR"]}},"required":["interval_type","interval_count"]}},"required":["amount","currency","plan_name","linked_to","linked_type","billing_interval","billing_defaults"]}},"components/schemas/createSubscriptionPlanDefaultDuration":{"id":"components/schemas/createSubscriptionPlanDefaultDuration","kind":"json-schema","title":"Subscription Plan - Default Duration","data":{"title":"Subscription Plan - Default Duration","allOf":[{"$ref":"#/components/schemas/createSubscriptionPlan"}]}},"components/schemas/createSubscriptionPlanDiscountPhase":{"id":"components/schemas/createSubscriptionPlanDiscountPhase","kind":"json-schema","title":"Subscription Plan - Discount Phase","data":{"title":"Subscription Plan - Discount Phase","allOf":[{"$ref":"#/components/schemas/createSubscriptionPlan"}]}},"components/schemas/createSubscriptionPlanTrialPhase":{"id":"components/schemas/createSubscriptionPlanTrialPhase","kind":"json-schema","title":"Subscription Plan - Trial Phase","data":{"title":"Subscription Plan - Trial Phase","allOf":[{"$ref":"#/components/schemas/createSubscriptionPlan"}]}},"components/schemas/updateSubscriptionPlan":{"id":"components/schemas/updateSubscriptionPlan","kind":"json-schema","title":"updateSubscriptionPlan","data":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/amount"},"description":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A description for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"nickname":{"$ref":"#/components/schemas/nickname"},"state":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Subscription Plan"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ACTIVE","INACTIVE"]},"tags":{"$ref":"#/components/schemas/tags"},"update_existing_subscriptions":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to update existing subscriptions created from this plan or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to make updates only effective for future subscriptions created from this plan. The default is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/deactivateSubscriptionPlan":{"id":"components/schemas/deactivateSubscriptionPlan","kind":"json-schema","title":"Deactivate a Subscription Plan","data":{"title":"Deactivate a Subscription Plan","allOf":[{"$ref":"#/components/schemas/updateSubscriptionPlan"}]}},"schema_0":{"kind":"json-schema","data":{"type":"string","default":"2022-02-01","example":"2022-02-01"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"string","example":"application/json"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/create3DSecureSessionUSA"},{"$ref":"#/components/schemas/create3DSecureSessionCAN"},{"$ref":"#/components/schemas/create3DSecureSessionToken"}]},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"date":{"type":"string","example":"Tue, 08 Jul 2025 17:38:01 GMT","description":"A response header indicating the date and time of the API request."},"finix-apiuser-role":{"type":"string","enum":["ROLE_PLATFORM","ROLE_PARTNER","ROLE_MERCHANT"],"example":"ROLE_PARTNER","description":"This response header indicating the role of the user who sent the API request."},"x-request-id":{"type":"string","example":"055972f6534f92a896fbb61b11313ebb","description":"This response header provides a unique identifier for the API request."}}},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"string","example":"3d_secure_session_wUCqan1LqeEHbYSwozMcFT"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createAuthorizationMinimalFields"},{"$ref":"#/components/schemas/createAuthorization"},{"$ref":"#/components/schemas/createAuthorizationCanada"},{"$ref":"#/components/schemas/createAuthorization3DSecure"},{"$ref":"#/components/schemas/createAuthorization3DSecureSession"},{"$ref":"#/components/schemas/createAuthorizationBuyerCharges"},{"$ref":"#/components/schemas/createAuthorizationCardPresent"},{"$ref":"#/components/schemas/createAuthorizationCVV"},{"$ref":"#/components/schemas/createAuthorizationVerifyCVVAndAVS"},{"$ref":"#/components/schemas/createAuthorizationAutoRental"},{"$ref":"#/components/schemas/createAuthorizationGaming"},{"$ref":"#/components/schemas/createAuthorizationLodging"},{"$ref":"#/components/schemas/createAuthorizationLevel2Processing"},{"$ref":"#/components/schemas/createAuthorizationLevel3Processing"},{"$ref":"#/components/schemas/createAuthorizationRecurringUnscheduled"}]},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"string"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"integer","example":100},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"string","example":"2022-09-27T11:21:23","format":"date-time"},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"string","example":"2026-09-27T11:21:23","format":"date-time"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","example":"USD"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","example":"DVsEanpBtsAVvCHbNXkFaH6f"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"string","example":"15d32948-c766-4033-8d87-dfbdcabcbc5c"},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"string","example":9444},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"string","example":411111},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"string","example":"VISA"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"string","example":1111},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"string","example":"Alice"},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"integer","example":10,"maximum":100},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","example":"MUeDVrf2ahuKc9Eg5TeZugvs"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","example":"John"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"type":"string","example":"FNXrzKj8xCLBwB8FdxjfU9txe"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"example":"SUCCEEDED","enum":["SUCCEEDED","FAILED","PENDING","CANCELED"]},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"string","example":"card_type"},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"string","example":"business_card"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"string","example":"021fc4ed-f0a8-4932-820c-b22b542526f8"},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}],"properties":{"authorizations":{"type":"array","minItems":0,"uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" objects."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/authorization"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"string","example":"AUrEnGqdBi5oJs68ChNRcHJ3"},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/captureAuthorization"},{"$ref":"#/components/schemas/captureAuthorizationCardPresent"},{"$ref":"#/components/schemas/captureAuthorizationSplitTransfers"}]},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"string","example":"MUwfZPNW3r4EqLMzwgr6txw4"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"string","enum":["INCOMPLETE","OVERDUE","COMPLETE","EXPIRED","INVALID"],"example":"COMPLETE"},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"compliance_forms":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/compliance_form"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"type":"string","example":"APc9vhYcPsRuTSpKD9KpMtPe"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"type":"boolean","example":true},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string","example":"IDtEnKsZyJNUGK83ZTx4C45S"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"type":"string","example":"john%%20smith"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"string","example":"PAX_A800"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"type":"string","example":"2210074802"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"devices":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/device"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/updateDeviceActivate"},{"$ref":"#/components/schemas/updateDeviceCancel"},{"$ref":"#/components/schemas/updateDeviceDeactivate"},{"$ref":"#/components/schemas/updateDeviceIdleFileImageMessage"},{"$ref":"#/components/schemas/updateDeviceSurcharges"}]},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"string","enum":["CLOSED","OPEN"],"example":"OPEN"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"string","enum":["CELLULAR","ETHERNET","WIFI"],"example":"WIFI"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"string","enum":["EXCELLENT","GOOD","POOR","VERY_POOR"],"example":"POOR"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"type":"string","enum":["APP_BACKGROUNDED","APP_OPENED","CHARGE_STATUS","SCHEDULED_INTERVAL","SERVER_CONNECTED","USER_INITIATED"],"example":"SCHEDULED_INTERVAL"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"string","example":"BACKGROUND","enum":["BACKGROUND","FOREGROUND"]},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"type":"string","example":"3.2.1"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"type":"integer","example":"75"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"number","format":"double","example":"32.5"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"boolean","example":"true"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"string","example":"12"},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"string","example":"2.1.0"},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createDeviceIOSTapToPay"},{"$ref":"#/components/schemas/createDevicePAXA800"},{"$ref":"#/components/schemas/createDevicePAXA920Pro"},{"$ref":"#/components/schemas/createDevicePAXD135"},{"$ref":"#/components/schemas/createDevicePAXIM30"},{"$ref":"#/components/schemas/createDeviceSDKMode"},{"$ref":"#/components/schemas/createDeviceStandalone"}]},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"disputes":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/dispute"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"string","example":"DIgDv9764vkkEVu1suZNCDbR"},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"evidences":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/dispute_evidence"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"transferes":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/transfer"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"string","example":"DIpCy4sZTx6im6U1ofBBPzdM"},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"string","example":"DFtiQ1LoNbjBTYiuuxju6tE2"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"fees":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/fee"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"type":"string","example":"FEnzgwGtLzFk61rDdUqsHFAj"},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/createFeeProfileBlended"},{"$ref":"#/components/schemas/createFeeProfileInterchangePlus"},{"$ref":"#/components/schemas/createFeeProfileInterchangePlusDuesAssessments"},{"$ref":"#/components/schemas/createFeeProfile"},{"$ref":"#/components/schemas/createFeeProfileNoFees"}]},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"Fee Profile":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/fee_profile"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"files":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/file"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","example":"FILE_cSfN6idvWZnBYXS5Vc1Pes"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"external_links":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/external_link"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createExternalLinkUpload"},{"$ref":"#/components/schemas/createExternalLinkDownload"},{"$ref":"#/components/schemas/createExternalLinkView"}]},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","example":"multipart/form-data"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/createIdentitySellerUSA"},{"$ref":"#/components/schemas/createIdentitySellerCAN"},{"$ref":"#/components/schemas/createIdentityRecipientBusiness"},{"$ref":"#/components/schemas/createIdentityRecipientPersonal"},{"$ref":"#/components/schemas/createIdentityBuyer"},{"$ref":"#/components/schemas/createIdentityBuyerBlank"},{"$ref":"#/components/schemas/createIdentitySenderAndRecipientPersonal"},{"$ref":"#/components/schemas/createIdentitySenderAndRecipientBusiness"}]},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"string","example":"Finix%20Flowers"},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"type":"string","example":"INDIVIDUAL_SOLE_PROPRIETORSHIP","enum":["INDIVIDUAL_SOLE_PROPRIETORSHIP","CORPORATION","LIMITED_LIABILITY_COMPANY","PARTNERSHIP","LIMITED_PARTNERSHIP","GENERAL_PARTNERSHIP","ASSOCIATION_ESTATE_TRUST","TAX_EXEMPT_ORGANIZATION","GOVERNMENT_AGENCY"]},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"type":"string","example":"user@example.org"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"string","example":"SELLER","enum":["APPLICATION_OWNER","BENEFICIAL_OWNER","BUYER","PLATFORM_OWNER","RECIPIENT","SELLER","SENDER"]},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"string","example":"Smith"},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"string","example":"ceo"},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"string","example":"BUSINESS","enum":["BUSINESS","PERSONAL"]},"id":"schema_75"},"schema_76":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources."},"children":[]}]}]}],"properties":{"identities":{"type":"array","uniqueItems":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource represents either a person or business in Finix."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/identity"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_76"},"schema_77":{"kind":"json-schema","data":{"type":"string","example":"IDoTsv1LvqoXFmXywU6SoiSE"},"id":"schema_77"},"schema_78":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"List of Merchants":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/merchant"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_78"},"schema_79":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createMerchantMinimalFields"},{"$ref":"#/components/schemas/createMerchant"},{"$ref":"#/components/schemas/createMerchantCardPresentEnabled"},{"$ref":"#/components/schemas/createMerchantDefaultPartialAuthorization"},{"$ref":"#/components/schemas/createMerchantLoanRepaymentEnabled"},{"$ref":"#/components/schemas/createMerchantRefundsDisabled"}]},"id":"schema_79"},"schema_80":{"kind":"json-schema","data":{"type":"string","example":"USA","enum":["USA","CAN"]},"id":"schema_80"},"schema_81":{"kind":"json-schema","data":{"type":"string","example":"USD","enum":["USD","CAD"]},"id":"schema_81"},"schema_82":{"kind":"json-schema","data":{"type":"string","example":"finix%20flowers"},"id":"schema_82"},"schema_83":{"kind":"json-schema","data":{"type":"string","example":"finix"},"id":"schema_83"},"schema_84":{"kind":"json-schema","data":{"type":"string","example":"jonathan"},"id":"schema_84"},"schema_85":{"kind":"json-schema","data":{"type":"string","example":"jon"},"id":"schema_85"},"schema_86":{"kind":"json-schema","data":{"type":"string","example":"ID6ZC4KedcaCwECQcWr7SM4m"},"id":"schema_86"},"schema_87":{"kind":"json-schema","data":{"type":"string","example":"williams"},"id":"schema_87"},"schema_88":{"kind":"json-schema","data":{"type":"string","example":"will"},"id":"schema_88"},"schema_89":{"kind":"json-schema","data":{"type":"string","example":"SELLER","enum":["APPLICATION_OWNER","RECIPIENT","SELLER"]},"id":"schema_89"},"schema_90":{"kind":"json-schema","data":{"type":"string","example":4900},"id":"schema_90"},"schema_91":{"kind":"json-schema","data":{"type":"string","example":"DUMMY_V1","enum":["FINIX_V1","DUMMY_V1"]},"id":"schema_91"},"schema_92":{"kind":"json-schema","data":{"type":"string","example":"VI7jopNSiaVMXWKkhxt6dJm7"},"id":"schema_92"},"schema_93":{"kind":"json-schema","data":{"type":"string","example":"MUiV7ntxfY4eyJxp6E7cZvym"},"id":"schema_93"},"schema_94":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/updateMerchantDisableProcessing"},{"$ref":"#/components/schemas/updateMerchantDisableSettlements"},{"$ref":"#/components/schemas/updateMerchantEnableBuyerCharges"},{"$ref":"#/components/schemas/updateMerchantEnableL2L3Processing"},{"$ref":"#/components/schemas/updateMerchantEnableLoanRepayment"},{"$ref":"#/components/schemas/updateMerchantEnablePartialAuthorizations"},{"$ref":"#/components/schemas/updateMerchantEnableSameDayACH"},{"$ref":"#/components/schemas/updateMerchantSettlementQueue"},{"$ref":"#/components/schemas/updateMerchantTerminate"}]},"id":"schema_94"},"schema_95":{"kind":"json-schema","data":{"type":"object","properties":{}},"id":"schema_95"},"schema_96":{"kind":"json-schema","data":{"type":"string","example":"PIcgYZswyRfqSSbvMsxuaHxZ"},"id":"schema_96"},"schema_97":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"microdeposits":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/microdeposit"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_97"},"schema_98":{"kind":"json-schema","data":{"type":"string","example":"microdeposit_4ek6YXRKJ1fqvs5E4oHNcY"},"id":"schema_98"},"schema_99":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createOnboardingFormUSAMinimal"},{"$ref":"#/components/schemas/createOnboardingFormUSAAllFields"},{"$ref":"#/components/schemas/createOnboardingFormCANMinimal"},{"$ref":"#/components/schemas/createOnboardingFormCANAllFields"}]},"id":"schema_99"},"schema_100":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createPaymentInstrumentCard"},{"$ref":"#/components/schemas/createPaymentInstrumentAccountUpdater"},{"$ref":"#/components/schemas/createPaymentInstrumentNetworkTokens"},{"$ref":"#/components/schemas/createPaymentInstrumentBankAccount"},{"$ref":"#/components/schemas/createPaymentInstrumentPlaidBankAccount"},{"$ref":"#/components/schemas/createPaymentInstrumentCanadianBankAccount"},{"$ref":"#/components/schemas/createPaymentInstrumentTokenCard"},{"$ref":"#/components/schemas/createPaymentInstrumentTokenAccountUpdater"},{"$ref":"#/components/schemas/createPaymentInstrumentTokenBankAccount"},{"$ref":"#/components/schemas/createPaymentInstrumentTokenNetworkTokens"},{"$ref":"#/components/schemas/createPaymentInstrumentApplePay"},{"$ref":"#/components/schemas/createPaymentInstrumentGooglePay"},{"$ref":"#/components/schemas/createPaymentInstrumentApplePayPassthrough"},{"$ref":"#/components/schemas/createPaymentInstrumentGooglePayPassthrough"}]},"id":"schema_100"},"schema_101":{"kind":"json-schema","data":{"oneOf":[{"title":"Payment Instrument - Card","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Card - Enable Account Updater","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Card - Enable Network Tokens","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Bank Account","allOf":[{"$ref":"#/components/schemas/payment_instrument_bank"}]},{"title":"Payment Instrument - Plaid Bank Account","allOf":[{"$ref":"#/components/schemas/payment_instrument_bank"}]},{"title":"Payment Instrument - Canadian Bank Account","allOf":[{"$ref":"#/components/schemas/payment_instrument_bank"}]},{"title":"Payment Instrument - Token - Enable Account Updater","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Token - Bank Account","allOf":[{"$ref":"#/components/schemas/payment_instrument_bank"}]},{"title":"Payment Instrument - Token - Card","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Token - Enable Network Tokens","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Apple Pay","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Google Pay","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Apple Pay - Passthrough","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Google Pay - Passthrough","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]}]},"id":"schema_101"},"schema_102":{"kind":"json-schema","data":{"type":"string","example":"4242"},"id":"schema_102"},"schema_103":{"kind":"json-schema","data":{"type":"string","example":"9444"},"id":"schema_103"},"schema_104":{"kind":"json-schema","data":{"type":"string","example":"411111"},"id":"schema_104"},"schema_105":{"kind":"json-schema","data":{"type":"string","example":"9"},"id":"schema_105"},"schema_106":{"kind":"json-schema","data":{"type":"string","example":"2029"},"id":"schema_106"},"schema_107":{"kind":"json-schema","data":{"type":"string","example":"0454"},"id":"schema_107"},"schema_108":{"kind":"json-schema","data":{"type":"string","example":"IDcWwprrKrD6cSh225JWPri3"},"id":"schema_108"},"schema_109":{"kind":"json-schema","data":{"type":"string","enum":["ALL","BANK_ACCOUNT","PAYMENT_CARD"],"example":"BANK_ACCOUNT"},"id":"schema_109"},"schema_110":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"payment_instruments":{"type":"array","uniqueItems":true,"items":{"oneOf":[{"$ref":"#/components/schemas/payment_instrument_card"},{"$ref":"#/components/schemas/payment_instrument_bank"}]}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_110"},"schema_111":{"kind":"json-schema","data":{"type":"string","example":"PIhWqjo3DU13WmFzWZFLngfa"},"id":"schema_111"},"schema_112":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/payment_instrument_card"},{"$ref":"#/components/schemas/payment_instrument_bank"}]},"id":"schema_112"},"schema_113":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/updatePaymentInstrumentDisable"},{"$ref":"#/components/schemas/updatePaymentInstrumentAccountUpdater"},{"$ref":"#/components/schemas/updatePaymentInstrumentNetworkTokens"},{"$ref":"#/components/schemas/updatePaymentInstrumentCardAddress"},{"$ref":"#/components/schemas/updatePaymentInstrumentName"},{"$ref":"#/components/schemas/updatePaymentInstrumentNameAndVerify"},{"$ref":"#/components/schemas/updatePaymentInstrumentTags"},{"$ref":"#/components/schemas/updatePaymentInstrumentAddressGoogleApplePay"},{"$ref":"#/components/schemas/updatePaymentInstrumentExpiration"},{"$ref":"#/components/schemas/updatePaymentInstrumentVerifyMicroDeposits"}]},"id":"schema_113"},"schema_114":{"kind":"json-schema","data":{"anyOf":[{"title":"Payment Instrument - Disable a Payment Instrument","oneOf":[{"$ref":"#/components/schemas/payment_instrument_bank"},{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Enable Account Updater","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Enable Network Tokens","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Update Card Address","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Update Name","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Update and Verify Name","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Update Tags","oneOf":[{"$ref":"#/components/schemas/payment_instrument_bank"},{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Add Address for Google or Apple Pay","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Update Expiration Date","allOf":[{"$ref":"#/components/schemas/payment_instrument_card"}]},{"title":"Payment Instrument - Verify Microdeposits","allOf":[{"$ref":"#/components/schemas/payment_instrument_bank"}]}]},"id":"schema_114"},"schema_115":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"instrument_history_entries":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/instrument_history_entry"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_115"},"schema_116":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/updatePaymentInstrumentVerificationCVV"},{"$ref":"#/components/schemas/updatePaymentInstrumentVerificationAddress"},{"$ref":"#/components/schemas/updatePaymentInstrumentVerificationName"}]},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"payment_instrument_associations":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/payment_instrument_association"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"string","example":"payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/updatePaymentInstrumentAssociation"},{"$ref":"#/components/schemas/updatePaymentInstrumentAssociationDisabled"}]},"id":"schema_119"},"schema_120":{"kind":"json-schema","data":{"type":"string","enum":["APPROVED","AWAITING_APPROVAL"]},"id":"schema_120"},"schema_121":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_121"},"schema_122":{"kind":"json-schema","data":{"type":"integer","example":2000},"id":"schema_122"},"schema_123":{"kind":"json-schema","data":{"type":"integer","example":2},"id":"schema_123"},"schema_124":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"settlements":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/Settlement"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_124"},"schema_125":{"kind":"json-schema","data":{"type":"string","example":"STcAm13tv77jyt5n3KQ553X"},"id":"schema_125"},"schema_126":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"settlement_entries":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/SettlementEntry"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_126"},"schema_127":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"transfers":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/transfer"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_127"},"schema_128":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"funding_transfer_attempts":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/SettlementFundingTransferAttempt"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_128"},"schema_129":{"kind":"json-schema","data":{"type":"string","example":"TRdhp3DszqDKbNvwtn7DDcUi"},"id":"schema_129"},"schema_130":{"kind":"json-schema","data":{"type":"string","enum":["ADJUSTMENT","DISPUTE_TRANSFER","FEE","REVERSE","SPLIT_TRANSFER","TRANSFER"],"example":"TRANSFER"},"id":"schema_130"},"schema_131":{"kind":"json-schema","data":{"type":"string","example":"2023-06-28T00:00:00","format":"date-time"},"id":"schema_131"},"schema_132":{"kind":"json-schema","data":{"type":"string","enum":["AWAITING_SETTLEMENT_TIME","PENDING","RELEASED"],"example":"PENDING"},"id":"schema_132"},"schema_133":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"settlement_queue_entries":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/settlement_queue_entry"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_133"},"schema_134":{"kind":"json-schema","data":{"type":"object","properties":{"_embedded":{"type":"object","properties":{"split_transfers":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/split_transfer"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}},"page":{"$ref":"#/components/schemas/page"}}},"id":"schema_134"},"schema_135":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createTransferMinimalFields"},{"$ref":"#/components/schemas/createTransferAllFields"},{"$ref":"#/components/schemas/createTransferCanadaEFT"},{"$ref":"#/components/schemas/createTransfer3DSecure"},{"$ref":"#/components/schemas/createTransfer3DSecureSession"},{"$ref":"#/components/schemas/createTransferBankPayout"},{"$ref":"#/components/schemas/createTransferBankPayoutSameDay"},{"$ref":"#/components/schemas/createTransferCardPayout"},{"$ref":"#/components/schemas/createTransferCardPresent"},{"$ref":"#/components/schemas/createTransferUnreferencedRefund"},{"$ref":"#/components/schemas/createTransferCardVerificationCheck"},{"$ref":"#/components/schemas/createTransferConvenienceFee"},{"$ref":"#/components/schemas/createTransferDebitBankAccount"},{"$ref":"#/components/schemas/createTransferFeeProfile"},{"$ref":"#/components/schemas/createTransferAutoRental"},{"$ref":"#/components/schemas/createTransferLodging"},{"$ref":"#/components/schemas/createTransferGaming"},{"$ref":"#/components/schemas/createTransferLvl2Processing"},{"$ref":"#/components/schemas/createTransferLvl3Processing"},{"$ref":"#/components/schemas/createTransferPartialAuthorization"},{"$ref":"#/components/schemas/createTransferRecurringUnscheduled"},{"$ref":"#/components/schemas/createTransferRentSurcharge"},{"$ref":"#/components/schemas/createTransferSplitTransaction"},{"$ref":"#/components/schemas/createTransferSurcharge"},{"$ref":"#/components/schemas/createTransferMeToMePullCard"},{"$ref":"#/components/schemas/createTransferMeToMePullBank"},{"$ref":"#/components/schemas/createTransferMeToMePullBankSameDay"},{"$ref":"#/components/schemas/createTransferMeToMePayoutCard"},{"$ref":"#/components/schemas/createTransferMeToMePayoutBank"},{"$ref":"#/components/schemas/createTransferMeToMePayoutBankSameDay"}]},"id":"schema_135"},"schema_136":{"kind":"json-schema","data":{"type":"string","example":"R03,R07"},"id":"schema_136"},"schema_137":{"kind":"json-schema","data":{"type":"string","example":"joh"},"id":"schema_137"},"schema_138":{"kind":"json-schema","data":{"type":"string","example":"ID6Qm3BQUxGFcCWZ185TS8sn"},"id":"schema_138"},"schema_139":{"kind":"json-schema","data":{"type":"string","example":"Doe"},"id":"schema_139"},"schema_140":{"kind":"json-schema","data":{"type":"string","example":"do"},"id":"schema_140"},"schema_141":{"kind":"json-schema","data":{"type":"string","example":"John%20Doe"},"id":"schema_141"},"schema_142":{"kind":"json-schema","data":{"type":"string","example":"john"},"id":"schema_142"},"schema_143":{"kind":"json-schema","data":{"type":"string","example":1234},"id":"schema_143"},"schema_144":{"kind":"json-schema","data":{"type":"string","example":601100},"id":"schema_144"},"schema_145":{"kind":"json-schema","data":{"type":"string","example":"MASTERCARD"},"id":"schema_145"},"schema_146":{"kind":"json-schema","data":{"type":"string","example":4242},"id":"schema_146"},"schema_147":{"kind":"json-schema","data":{"type":"string","example":"USA,CAN"},"id":"schema_147"},"schema_148":{"kind":"json-schema","data":{"type":"string","example":"Business%20Card"},"id":"schema_148"},"schema_149":{"kind":"json-schema","data":{"type":"string","enum":["PAYMENT_CARD","BANK_ACCOUNT"],"example":"PAYMENT_CARD"},"id":"schema_149"},"schema_150":{"kind":"json-schema","data":{"type":"string","example":"MUtAWVfXkf149BVi2cL2HvPU"},"id":"schema_150"},"schema_151":{"kind":"json-schema","data":{"type":"string","example":"IDtX3ciHPq2DDquCQJRwj7VW"},"id":"schema_151"},"schema_152":{"kind":"json-schema","data":{"type":"string","example":"FNXkitpwdmgMJ8Vz9FxKBCSza"},"id":"schema_152"},"schema_153":{"kind":"json-schema","data":{"type":"string","example":"DUMMY_V1"},"id":"schema_153"},"schema_154":{"kind":"json-schema","data":{"type":"string","example":"TRjAnCNNSxDCW8GDsxYobHHe"},"id":"schema_154"},"schema_155":{"kind":"json-schema","data":{"type":"string","enum":["ALL","CANCELED","FAILED","PENDING","RETURNED","SUCCEEDED"],"example":"SUCCEEDED"},"id":"schema_155"},"schema_156":{"kind":"json-schema","data":{"type":"string","enum":["ALL","DEBIT","CREDIT","REVERSAL","SETTLEMENT"],"example":"REVERSAL"},"id":"schema_156"},"schema_157":{"kind":"json-schema","data":{"type":"string","example":"TRrC36MYGH6n67wRfYs8w8RK"},"id":"schema_157"},"schema_158":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/createTransferReversal"},{"$ref":"#/components/schemas/createTransferReversalSplitTransaction"},{"$ref":"#/components/schemas/createTransferReversalReferencedRefund"}]},"id":"schema_158"},"schema_159":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"users":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/user"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_159"},"schema_160":{"kind":"json-schema","data":{"type":"string","example":"USarwmxQ4Mxv6trtYit8bVhy"},"id":"schema_160"},"schema_161":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/updateUserTags"},{"$ref":"#/components/schemas/updateUserDisable"}]},"id":"schema_161"},"schema_162":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"verifications":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/merchant_verification"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_162"},"schema_163":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"verifications":{"type":"array","uniqueItems":true,"items":{"oneOf":[{"$ref":"#/components/schemas/payment_instrument_verification"},{"$ref":"#/components/schemas/merchant_verification"}]}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_163"},"schema_164":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/merchant_verification"},{"$ref":"#/components/schemas/payment_instrument_verification"}]},"id":"schema_164"},"schema_165":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createWebhookAllFields"},{"$ref":"#/components/schemas/createWebhookMinimalFields"},{"$ref":"#/components/schemas/createWebhookBasicAuthentication"},{"$ref":"#/components/schemas/createWebhookBearerToken"},{"$ref":"#/components/schemas/createWebhookEventFiltering"}]},"id":"schema_165"},"schema_166":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"webhooks":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/webhook"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_166"},"schema_167":{"kind":"json-schema","data":{"type":"string","example":"WHhRJLcEt53voydzyLQ9aYs7"},"id":"schema_167"},"schema_168":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/updateWebhookAllFields"},{"$ref":"#/components/schemas/updateWebhookAuthentication"},{"$ref":"#/components/schemas/updateWebhookEnableDisable"},{"$ref":"#/components/schemas/updateWebhookEventFiltering"}]},"id":"schema_168"},"schema_169":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"gateway_integrations":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/GatewayIntegration"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_169"},"schema_170":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createReceiptMinimalFields"},{"$ref":"#/components/schemas/createReceipt"}]},"id":"schema_170"},"schema_171":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"delivery_attempts":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/receipt_delivery_attempt"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_171"},"schema_172":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/createSubscriptionMinimalFields"},{"$ref":"#/components/schemas/createSubscription"},{"$ref":"#/components/schemas/createSubscriptionBillingCycleDay"},{"$ref":"#/components/schemas/createSubscriptionDiscountPhase"},{"$ref":"#/components/schemas/createSubscriptionFixed"},{"$ref":"#/components/schemas/createSubscriptionFixedEndDate"},{"$ref":"#/components/schemas/createSubscriptionFuture"},{"$ref":"#/components/schemas/createSubscriptionTrial"},{"$ref":"#/components/schemas/createSubscriptionFromPlanMinimalFields"},{"$ref":"#/components/schemas/createSubscriptionFromPlan"},{"$ref":"#/components/schemas/createSubscriptionFromPlanFixed"},{"$ref":"#/components/schemas/createSubscriptionFromPlanFixedEndDate"},{"$ref":"#/components/schemas/createSubscriptionFromPlanFuture"}]},"id":"schema_172"},"schema_173":{"kind":"json-schema","data":{"type":"string","enum":["BIMONTHLY","BIWEEKLY","BIYEARLY","DAILY","MONTHLY","QUARTERLY","SEMIYEARLY","TRIYEARLY","WEEKLY","YEARLY"],"example":"MONTHLY"},"id":"schema_173"},"schema_174":{"kind":"json-schema","data":{"type":"string","example":"MUcgYZswyRfqSSbvMsxuaHxZ"},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"string","example":"NOT_STARTED"},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"type":"string","example":"subscription_link_cvTp2K5CNH9Lr4BqCphcM"},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"string","example":"subscription_plan_ciLn19pSKDTFoehtH7ET"},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"Subscription":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/subscription"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"type":"string","example":"subscription_cAqNtRY2oKTJWbjMSDgrk"},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/updateSubscription"},{"$ref":"#/components/schemas/updateSubscriptionBillingCycleDay"},{"$ref":"#/components/schemas/updateSubscriptionNewPlan"}]},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"subscription_balance_entries":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/subscription_balance_entry"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/createSubscriptionPlan"},{"$ref":"#/components/schemas/createSubscriptionPlanDefaultDuration"},{"$ref":"#/components/schemas/createSubscriptionPlanDiscountPhase"},{"$ref":"#/components/schemas/createSubscriptionPlanTrialPhase"}]},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"string","example":"INACTIVE"},"id":"schema_183"},"schema_184":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"subscription_plans":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/subscription_plan"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_184"},"schema_185":{"kind":"json-schema","data":{"type":"string","example":"subscription_plan_cAqNsG7EbVUgqvV3JGhR7"},"id":"schema_185"},"schema_186":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/updateSubscriptionPlan"},{"$ref":"#/components/schemas/deactivateSubscriptionPlan"}]},"id":"schema_186"},"schema_187":{"kind":"json-schema","data":{"type":"string","example":"AUogt3PgskE2ahBFmTpn2EGJ"},"id":"schema_187"},"schema_188":{"kind":"json-schema","data":{"type":"string","example":"john@example.com"},"id":"schema_188"},"schema_189":{"kind":"json-schema","data":{"type":"string","example":"checkout_form_ciADaDNMFAHdyNbDPuByS"},"id":"schema_189"},"schema_190":{"kind":"json-schema","data":{"type":"string","enum":["CHECKOUT_FORM","PAYMENT_LINK","PAYOUT_LINK"],"example":"PAYMENT_LINK"},"id":"schema_190"},"schema_191":{"kind":"json-schema","data":{"type":"string","enum":["FAILED","PENDING","SUCCEEDED"],"example":"SUCCEEDED"},"id":"schema_191"},"schema_192":{"kind":"json-schema","data":{"type":"string","example":"TRnH7FkSB7zePeHExNZwSb9H"},"id":"schema_192"},"schema_193":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"transfer_attempts":{"type":"array","uniqueItems":true,"items":{"oneOf":[{"$ref":"#/components/schemas/TransferAttemptCheckoutForm"},{"$ref":"#/components/schemas/TransferAttemptPaymentLink"},{"$ref":"#/components/schemas/TransferAttemptPayoutLink"}]}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_193"},"schema_194":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/TransferAttemptCheckoutForm"},{"$ref":"#/components/schemas/TransferAttemptPaymentLink"},{"$ref":"#/components/schemas/TransferAttemptPayoutLink"}]},"id":"schema_194"},"schema_195":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"balances":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/balance"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_195"},"schema_196":{"kind":"json-schema","data":{"type":"string","example":"TR2vw93rwm6LkH1MES6T9uYe"},"id":"schema_196"},"schema_197":{"kind":"json-schema","data":{"type":"string","enum":["BALANCE_ADJUSTMENT","TRANSFER"]},"id":"schema_197"},"schema_198":{"kind":"json-schema","data":{"type":"string","example":"balance_entry_7s6EstknMq5KekMooedkES"},"id":"schema_198"},"schema_199":{"kind":"json-schema","data":{"type":"string","example":"balance_entry_xxx"},"id":"schema_199"},"schema_200":{"kind":"json-schema","data":{"type":"string","enum":["FAILED","PENDING","RETURNED","SUCCEEDED"],"example":"SUCCEEDED"},"id":"schema_200"},"schema_201":{"kind":"json-schema","data":{"type":"string","enum":["BALANCE_TOP_UP_ACH","BALANCE_WITHDRAWAL_ACH","MANUAL_BALANCE_ADJUSTMENT_DECREASE","MANUAL_BALANCE_ADJUSTMENT_INCREASE","PULL_FROM_ACH","PULL_FROM_CARD","PULL_FROM_SAME_DAY_ACH","PUSH_TO_ACH","PUSH_TO_CARD","PUSH_TO_SAME_DAY_ACH"]},"id":"schema_201"},"schema_202":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"balance_adjustments":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/balance_adjustment"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_202"},"schema_203":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"disbursement_rules":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/disbursement_rule"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_203"},"schema_204":{"kind":"json-schema","data":{"type":"object","properties":{"page":{"$ref":"#/components/schemas/page"},"_embedded":{"type":"object","properties":{"current_usages":{"type":"array","uniqueItems":true,"items":{"$ref":"#/components/schemas/current_usage"}}}},"_links":{"type":"object","properties":{"self":{"$ref":"#/components/schemas/self"},"next":{"$ref":"#/components/schemas/next"}}}}},"id":"schema_204"}},"exampleStore":{"paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - USA":{"value":{"amount":92169,"currency":"USD","merchant_id":"MUmfEGv5bMpSJ9k5TFRUjkmm","payment_instrument_id":"PI6iQcTtJNCS8GZAVKYi5Ueb","redirect_url":"https://example.com/3d-secure/return","tags":{"info":"Create 3DS Session with Payment Instrument"}},"key":"3D Secure Session - Payment Instrument - USA","summary":"3D Secure Session - Payment Instrument - USA","id":"paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - USA"},"paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada":{"value":{"amount":92169,"currency":"CAD","merchant_id":"MU2yvjFq3VLR3ifgFXGfDL1Z","payment_instrument_id":"PI6WVhDmAXnZzCtDJn7q71hQ","redirect_url":"https://example.com/3d-secure/return","tags":{"info":"Create 3DS Session with Payment Instrument"}},"key":"3D Secure Session - Payment Instrument - Canada","summary":"3D Secure Session - Payment Instrument - Canada","id":"paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada"},"paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Token":{"value":{"amount":1000,"currency":"USD","merchant_id":"MUmUNeW5N9Yw8RkLhLcGghy4","tags":{"info":"Create 3DS Session with Token"},"token_id":"TKiMxe323RE5Dq3wLVtG8kSW"},"key":"3D Secure Session - Token","summary":"3D Secure Session - Token","id":"paths/~13d_secure_sessions/post/requestBody/content/application~1json/examples/3D Secure Session - Token"},"paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - USA":{"value":{"id":"3d_secure_session_wUCqan1LqeEHbYSwozMcFT","created_at":"2026-11-12T00:16:59.350867Z","updated_at":"2026-11-12T00:16:59.875145Z","3d_secure_authentication":null,"3d_secure_authentication_session_id":"tds_visa_a4a702d77a7b","3d_secure_authentication_url":"https://3ds.evervault.com/?team=team_9cde05552cdc&app=app_690b5cac78d3&session=tds_visa_a4a702d77a7b&redirect=https%3A%2F%2Fexample.com%2F3d-secure%2Freturn","3d_secure_version":null,"amount":92169,"authentication_type":null,"currency":"USD","failure_code":null,"failure_message":null,"merchant_id":"MUmfEGv5bMpSJ9k5TFRUjkmm","payment_instrument_id":"PI6iQcTtJNCS8GZAVKYi5Ueb","redirect_url":"https://example.com/3d-secure/return","state":"PENDING","tags":{"info":"Create 3DS Session with Payment Instrument"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions/3d_secure_session_wUCqan1LqeEHbYSwozMcFT"}}},"key":"3D Secure Session - Payment Instrument - USA","summary":"3D Secure Session - Payment Instrument - USA","id":"paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - USA"},"paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada":{"value":{"id":"3d_secure_session_5eNJEwNTCC5zyQ2hQszN4q","created_at":"2026-10-21T17:26:00.844244Z","updated_at":"2026-10-21T17:26:01.054202Z","3d_secure_authentication":null,"3d_secure_authentication_session_id":"tds_mastercard_e1c1ed2162ce","3d_secure_authentication_url":"https://3ds.evervault.com/?team=team_9cde05552cdc&app=app_690b5cac78d3&session=tds_mastercard_e1c1ed2162ce&redirect=https%3A%2F%2Fexample.com%2F3d-secure%2Freturn","3d_secure_version":null,"amount":92169,"authentication_type":null,"currency":"CAD","failure_code":null,"failure_message":null,"merchant_id":"MU2yvjFq3VLR3ifgFXGfDL1Z","payment_instrument_id":"PI6WVhDmAXnZzCtDJn7q71hQ","redirect_url":"https://example.com/3d-secure/return","state":"PENDING","tags":{"info":"Create 3DS Session with Payment Instrument"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions/3d_secure_session_5eNJEwNTCC5zyQ2hQszN4q"}}},"key":"3D Secure Session - Payment Instrument - Canada","summary":"3D Secure Session - Payment Instrument - Canada","id":"paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Payment Instrument - Canada"},"paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Token":{"value":{"id":"3d_secure_session_f3fG3Zj8K958MTP5vpXAXX","created_at":"2026-08-13T16:37:59.211335Z","updated_at":"2026-08-13T16:37:59.469140Z","3d_secure_authentication":null,"3d_secure_authentication_session_id":"tds_visa_0367b8b7ebd8","3d_secure_authentication_url":null,"3d_secure_version":null,"amount":1000,"authentication_type":null,"currency":"USD","failure_code":null,"failure_message":null,"merchant_id":"MUmUNeW5N9Yw8RkLhLcGghy4","payment_instrument_id":null,"redirect_url":null,"state":"PENDING","tags":{"info":"Create 3DS Session with Token"}},"key":"3D Secure Session - Token","summary":"3D Secure Session - Token","id":"paths/~13d_secure_sessions/post/responses/201/content/application~1json/examples/3D Secure Session - Token"},"paths/~13d_secure_sessions/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~13d_secure_sessions/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~13d_secure_sessions/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~13d_secure_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~13d_secure_sessions/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~13d_secure_sessions/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~13d_secure_sessions/post/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"3937b6ad1bdf63381a68d2cd8ed8d92b","message":"Instrument not found PI6iQcTtJNCS8GZAVKYi5Ueb.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~13d_secure_sessions/post/responses/404/content/application~1json/examples/Not found"},"paths/~13d_secure_sessions/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~13d_secure_sessions/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/200/content/application~1json/examples/3D Secure Session":{"value":{"id":"3d_secure_session_f3fG3Zj8K958MTP5vpXAXX","created_at":"2026-08-13T16:37:59.211335Z","updated_at":"2026-08-13T16:38:47.663201Z","3d_secure_authentication":{"cardholder_authentication":"BwABBJQ1AgAAAAAgJDUCAAAAAAA=","electronic_commerce_indicator":"AUTHENTICATED","transaction_id":"EaOMucALHQqLAEGAgk"},"3d_secure_authentication_session_id":"tds_visa_0367b8b7ebd8","3d_secure_authentication_url":null,"3d_secure_version":"2.2.0","amount":1000,"authentication_type":"CHALLENGE","currency":"USD","failure_code":null,"failure_message":null,"merchant_id":"MUmUNeW5N9Yw8RkLhLcGghy4","payment_instrument_id":null,"redirect_url":null,"state":"SUCCEEDED","tags":{"info":"Create 3DS Session with Token"}},"key":"3D Secure Session","summary":"3D Secure Session","id":"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/200/content/application~1json/examples/3D Secure Session"},"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions/3d_secure_session_f3fG3Zj8K958MTP5vpXAXX"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions/3d_secure_session_f3fG3Zj8K958MTP5vpXAXX"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"3D Secure Session with id 3d_secure_session_f3fG3Zj8K958MTP5vpXAXX not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions/3d_secure_session_f3fG3Zj8K958MTP5vpXAXX"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/3d_secure_sessions/3d_secure_session_f3fG3Zj8K958MTP5vpXAXX"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~13d_secure_sessions~1{3d_secure_session_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Minimal Fields":{"value":{"amount":10000,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Authorization - Minimal Fields","summary":"Authorization - Minimal Fields","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Minimal Fields"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - All Fields":{"value":{"3d_secure_authentication":{"cardholder_authentication":"BwABBJQ1AgAAAAAgJDUCAAAAAAA=","electronic_commerce_indicator":"AUTHENTICATED","transaction_id":"EaOMucALHQqLAEGAgk"},"additional_buyer_charges":{"convenience_amount":10},"additional_healthcare_data":{"clinic_amount":50,"dental_amount":200,"prescription_amount":300,"vision_amount":300},"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":10,"discount_amount":100,"item_data":[{"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"commodity_code":"175-62-20","cost_per_unit":500,"item_description":"Consulting Services","item_discount_amount":100,"merchant_product_code":"SKU 12312","quantity":1,"unit_of_measure":"BX"},{"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"commodity_code":"207-72-54","cost_per_unit":500,"item_description":"GPT-5.6","item_discount_amount":0,"merchant_product_code":"SKU 2222","quantity":1,"unit_of_measure":"CTN"}],"shipping_amount":100},"amount":10000,"currency":"USD","ip_address_v4":"192.168.1.1","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","security_code":"022","source":"PIkxmtueemLD6dN9ZoWGHT44","statement_descriptor":"FINIX FLOWERS","tags":{"order_id":"ORD-123"}},"key":"Authorization - All Fields","summary":"Authorization - All Fields","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - All Fields"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Canada":{"value":{"amount":100,"currency":"CAD","merchant":"MUoG7LpUyPFT8XTrEFPvwvyJ","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Authorization - Canada","summary":"Authorization - Canada","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Canada"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure":{"value":{"3d_secure_authentication":{"cardholder_authentication":"BwABBJQ1AgAAAAAgJDUCAAAAAAA=","electronic_commerce_indicator":"AUTHENTICATED","transaction_id":"EaOMucALHQqLAEGAgk"},"amount":10000,"currency":"USD","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Authorization - 3D Secure","summary":"Authorization - 3D Secure","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure Session":{"value":{"3d_secure_session":"3d_secure_session_c5dR7Wk1H392XJq6tzNCUb","amount":10000,"currency":"USD","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Authorization - 3D Secure Session","summary":"Authorization - 3D Secure Session","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - 3D Secure Session"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Authorization with CVV":{"value":{"amount":10000,"currency":"USD","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","security_code":"022","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Authorization - Authorization with CVV","summary":"Authorization - Authorization with CVV","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Authorization with CVV"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Verify CVV and AVS":{"value":{"amount":0,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Authorization - Verify CVV and AVS","summary":"Authorization - Verify CVV and AVS","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Verify CVV and AVS"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Buyer Charges":{"value":{"additional_buyer_charges":{"convenience_amount":10},"amount":10000,"currency":"USD","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","source":"PIkxmtueemLD6dN9ZoWGHT44","statement_descriptor":"FINIX FLOWERS","tags":{"order_id":"ORD-123"}},"key":"Authorization - Buyer Charges","summary":"Authorization - Buyer Charges","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Buyer Charges"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Card Present":{"value":{"amount":150,"currency":"USD","device":"DVhCtTEMVHnDPFMh2KQLrFSi","operation_key":"CARD_PRESENT_AUTHORIZATION"},"key":"Authorization - Card Present","summary":"Authorization - Card Present","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Card Present"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Motor Vehicle Rental":{"value":{"additional_motor_vehicle_rental_data":{"customer_service_number":"8005551234","extra_charge_details":{"one_way_service_fee_amount":5000},"is_no_show":false,"motor_vehicle_rental_agreement_number":"AGR-00142","number_of_days":4,"pickup_address":{"city":"San Francisco","country":"USA","line1":"123 Market St","line2":null,"postal_code":"94105","region":"CA"},"pickup_date":{"day":1,"month":4,"year":2026},"rental_rate":"7500","renter_name":"John Doe","return_address":{"city":"Los Angeles","country":"USA","line1":"456 Hollywood Blvd","line2":"Suite 100","postal_code":"90028","region":"CA"},"return_date":{"day":4,"month":4,"year":2026}},"amount":35000,"currency":"USD","merchant":"MU5Yj7n78VrPjA83zED4NSAt","source":"PIkxmtueemLD6dN9ZoWGHT44","tags":{"order_id":"ORD-123"}},"key":"Authorization - Motor Vehicle Rental","summary":"Authorization - Motor Vehicle Rental","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Motor Vehicle Rental"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Gaming":{"value":{"amount":10000,"currency":"USD","ip_address_v4":"192.168.1.1","merchant":"MUmKTKuetVV1MQ5Cq6rjWA5j","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Authorization - Gaming","summary":"Authorization - Gaming","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Gaming"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Lodging":{"value":{"additional_lodging_data":{"check_in_date":{"day":1,"month":4,"year":2026},"check_out_date":{"day":5,"month":4,"year":2026},"customer_service_phone":"8005551234","extra_charge_details":{"mini_bar_amount":500},"hotel_agreement_number":"HTL98765","is_advance_deposit":false,"is_no_show":false,"number_of_nights":4,"property_phone":"4155559876","room_rate":"10000","room_tax":"1500"},"amount":45000,"currency":"USD","merchant":"MUvjH7MLwEpT3pkVmu7VvNaQ","source":"PIkxmtueemLD6dN9ZoWGHT44","tags":{"order_id":"ORD-123"}},"key":"Authorization - Lodging","summary":"Authorization - Lodging","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Lodging"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 2 Processing":{"value":{"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","sales_tax":200},"amount":10000,"currency":"USD","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","source":"PIs3rzrjP9orEjBwtJjhxEjL"},"key":"Authorization - Level 2 Processing","summary":"Authorization - Level 2 Processing","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 2 Processing"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 3 Processing":{"value":{"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":0,"discount_amount":100,"item_data":[{"amount_excluding_sales_tax":400,"amount_including_sales_tax":440,"commodity_code":"175-62-20","cost_per_unit":500,"item_description":"IT Network Assessment","item_discount_amount":100,"merchant_product_code":"SVC-NET-ASMT","quantity":1,"unit_of_measure":"HUR"},{"amount_excluding_sales_tax":500,"amount_including_sales_tax":550,"commodity_code":"207-72-54","cost_per_unit":500,"item_description":"USB-C Charging Cable 6ft","item_discount_amount":0,"merchant_product_code":"CBL-USBC-6FT","quantity":1,"unit_of_measure":"EA"}],"shipping_amount":100},"amount":990,"currency":"USD","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Authorization - Level 3 Processing","summary":"Authorization - Level 3 Processing","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Level 3 Processing"},"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Recurring or Unscheduled":{"value":{"amount":10000,"credential_on_file":{"initial_transfer_id":"TRwWJd8NPvfaxp7nqnud8etF","type":"RECURRING"},"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PI6iQcTtJNCS8GZAVKYi5Ueb"},"key":"Authorization - Recurring or Unscheduled","summary":"Authorization - Recurring or Unscheduled","id":"paths/~1authorizations/post/requestBody/content/application~1json/examples/Authorization - Recurring or Unscheduled"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Minimal Fields":{"value":{"id":"AUibEDBG2DzmPJ3L75pxfFu2","created_at":"2026-09-25T20:05:04.31Z","updated_at":"2026-09-25T20:05:04.31Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:05:04.31Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"766600"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"72e93698-4cd9-4ccd-bb1c-a965fb5c9cef","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUibEDBG2DzmPJ3L75pxfFu2"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},"key":"Authorization - Minimal Fields","summary":"Authorization - Minimal Fields","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Minimal Fields"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - All Fields":{"value":{"id":"AUbnRuZ3jpApRxGBukigsXai","created_at":"2026-09-25T20:04:56.95Z","updated_at":"2026-09-25T20:04:56.95Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":{"convenience_amount":10,"surcharge_amount":0,"rent_surcharge_amount":0},"additional_healthcare_data":{"clinic_amount":50,"dental_amount":200,"prescription_amount":300,"vision_amount":300},"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":10,"destination_country_code":null,"destination_postal_code":null,"discount_amount":100,"invoice_reference_number":null,"order_date":null,"sales_tax":null,"sales_tax_finix_generated":200,"ship_from_postal_code":null,"shipping_amount":100,"tax_exempt":false,"item_data":[{"cost_per_unit":500,"item_description":"Consulting Services","item_discount_amount":100,"merchant_product_code":"SKU 12312","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"BX","commodity_code":"175-62-20","sales_tax_amount":100,"sales_tax_rate":0.25},{"cost_per_unit":500,"item_description":"GPT-5.6","item_discount_amount":0,"merchant_product_code":"SKU 2222","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"CTN","commodity_code":"207-72-54","sales_tax_amount":100,"sales_tax_rate":0.25}]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:04:56.95Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"908105"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{"order_id":"ORD-123"},"trace_id":"453af9f5-5016-40c6-9e3c-efcddbe45d7b","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUbnRuZ3jpApRxGBukigsXai"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},"key":"Authorization - All Fields","summary":"Authorization - All Fields","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - All Fields"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Canada":{"value":{"id":"AU2BK3RtDESEJEJTXynAtmSw","created_at":"2026-09-25T20:05:00.49Z","updated_at":"2026-09-25T20:05:00.49Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":100,"amount_requested":100,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"CAD","expires_at":"2026-10-05T20:05:00.49Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUoG7LpUyPFT8XTrEFPvwvyJ","merchant_identity":"ID25DKjXGUcD6Lr6A4cUndYw","messages":[],"network_details":{"brand":"VISA","authorization_code":"946995"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"942b0dab-926d-4267-a3fa-9b3df5c1eeb6","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AU2BK3RtDESEJEJTXynAtmSw"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID25DKjXGUcD6Lr6A4cUndYw"}}},"key":"Authorization - Canada","summary":"Authorization - Canada","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Canada"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure":{"value":{"id":"AUt8zShMVsZT8RyYDMhs9wu1","created_at":"2026-09-25T20:04:57.64Z","updated_at":"2026-09-25T20:04:57.64Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:04:57.64Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":{"brand":"VISA","authorization_code":"349025"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"b282586b-1057-4088-971e-f5c8e461cae8","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUt8zShMVsZT8RyYDMhs9wu1"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"}}},"key":"Authorization - 3D Secure","summary":"Authorization - 3D Secure","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure Session":{"value":{"id":"AUq2WcYbTn4KpRLdHxV7sZm9","created_at":"2026-09-17T21:09:08.04Z","updated_at":"2026-09-17T21:09:08.04Z","3d_secure_session":"3d_secure_session_c5dR7Wk1H392XJq6tzNCUb","3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-09-27T21:09:08.04Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":{"brand":"VISA","authorization_code":"488251"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"71e9c4b6-0d58-42af-8b13-cc6a25f0e37d","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUq2WcYbTn4KpRLdHxV7sZm9"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"}}},"key":"Authorization - 3D Secure Session","summary":"Authorization - 3D Secure Session","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - 3D Secure Session"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Authorization with CVV":{"value":{"id":"AU7aZUR24XBve4EtmFQJewmq","created_at":"2026-09-25T20:04:59.71Z","updated_at":"2026-09-25T20:04:59.71Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:04:59.71Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":{"brand":"VISA","authorization_code":"919274"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"9c262e63-cc9d-46ba-ac04-943a229652cc","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AU7aZUR24XBve4EtmFQJewmq"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"}}},"key":"Authorization - Authorization with CVV","summary":"Authorization - Authorization with CVV","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Authorization with CVV"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Verify CVV and AVS":{"value":{"id":"AUtEwwfFj3NuseRdx3iGuWVa","created_at":"2026-10-15T18:44:12.40Z","updated_at":"2026-10-15T18:44:12.40Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":0,"amount_requested":0,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-25T18:44:12.40Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"864467"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"1c8ea88c-0bb7-44b0-bc5b-6d066abf7580","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUtEwwfFj3NuseRdx3iGuWVa"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},"key":"Authorization - Verify CVV and AVS","summary":"Authorization - Verify CVV and AVS","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Verify CVV and AVS"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Buyer Charges":{"value":{"id":"AUqNBRdp7frYYbCH5yHxcJ7v","created_at":"2026-09-25T20:04:59.05Z","updated_at":"2026-09-25T20:04:59.05Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":{"convenience_amount":10,"surcharge_amount":0,"rent_surcharge_amount":0},"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:04:59.05Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":{"brand":"VISA","authorization_code":"656067"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{"order_id":"ORD-123"},"trace_id":"ff1ae9d1-9fea-4107-97d3-aae7d05c0563","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUqNBRdp7frYYbCH5yHxcJ7v"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"}}},"key":"Authorization - Buyer Charges","summary":"Authorization - Buyer Charges","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Buyer Charges"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Card Present":{"value":{"id":"AUgEVBSEkyFdEJ4ur8UbBWw6","created_at":"2026-09-28T20:30:39.71Z","updated_at":"2026-09-28T20:30:39.71Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":150,"amount_requested":150,"application":"APc9vhYcPsRuTSpKD9KpMtPe","card_present_details":{"approval_code":"135761","brand":"VISA","digital_signature_file_id":null,"emv_data":{"application_identifier":"A0000000031010","application_label":"VISA CREDIT","application_preferred_name":null,"application_transaction_counter":"0033","cryptogram":"ARQC CBEE0E04EDD490A9","issuer_code_table_index":null,"network_emv_response":null,"pin_verified":false,"tags":null},"entry_mode":"CONTACTLESS","masked_account_number":"476173******0010","name":null,"payment_type":"CREDIT"},"created_via":"CARD_PRESENT_SEMI_INTEGRATED_API","currency":"USD","device":"DVhCtTEMVHnDPFMh2KQLrFSi","expires_at":"2026-10-05T20:30:39.71Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmFY9PWbqJPGtQEN7RXdFAb","merchant_identity":"IDvEVPqD9rnfLCAGnLJphyGT","messages":[],"network_details":{"brand":"VISA","authorization_code":"135761"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":"PIbHf6aXRrZQAHYiu1UeKB93","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"68cf2b9c-0b94-458a-9167-b06903bb5136","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUgEVBSEkyFdEJ4ur8UbBWw6"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"device":{"href":"https://finix.sandbox-payments-api.com/devices/DVhCtTEMVHnDPFMh2KQLrFSi"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvEVPqD9rnfLCAGnLJphyGT"}}},"key":"Authorization - Card Present","summary":"Authorization - Card Present","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Card Present"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Motor Vehicle Rental":{"value":{"id":"AUemv55gdAyMZKCGjMru5A6d","created_at":"2026-09-25T20:04:58.28Z","updated_at":"2026-09-25T20:04:58.28Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":{"motor_vehicle_rental_agreement_number":"AGR-00142","customer_service_number":"8005551234","extra_charge_details":{"one_way_service_fee_amount":5000,"fuel_amount":null,"extra_mileage_amount":null,"parking_violation_amount":null,"late_return_amount":null,"insurance_amount":null},"is_no_show":false,"number_of_days":4,"pickup_address":{"line1":"123 Market St","line2":null,"city":"San Francisco","region":"CA","postal_code":"94105","country":"USA"},"pickup_date":{"day":1,"month":4,"year":2026},"rental_rate":"7500","renter_name":"John Doe","return_address":{"line1":"456 Hollywood Blvd","line2":"Suite 100","city":"Los Angeles","region":"CA","postal_code":"90028","country":"USA"},"return_date":{"day":4,"month":4,"year":2026}},"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":35000,"amount_requested":35000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:04:58.28Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MU5Yj7n78VrPjA83zED4NSAt","merchant_identity":"IDuaq66v5kqLZCSy31BjKCwD","messages":[],"network_details":{"brand":"VISA","authorization_code":"702242"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{"order_id":"ORD-123"},"trace_id":"04b23f4b-c152-48d4-9070-236eb5c4e05a","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUemv55gdAyMZKCGjMru5A6d"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDuaq66v5kqLZCSy31BjKCwD"}}},"key":"Authorization - Motor Vehicle Rental","summary":"Authorization - Motor Vehicle Rental","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Motor Vehicle Rental"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Lodging":{"value":{"id":"AUfcQv7Mat2YqvYK9pF7xWeU","created_at":"2026-09-25T20:05:03.69Z","updated_at":"2026-09-25T20:05:03.69Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":{"check_in_date":{"day":1,"month":4,"year":2026},"check_out_date":{"day":5,"month":4,"year":2026},"customer_service_phone":"8005551234","extra_charge_details":{"mini_bar_amount":500,"gift_shop_amount":null,"phone_amount":null,"restaurant_amount":null,"laundry_amount":null,"other_amount":null},"hotel_agreement_number":"HTL98765","is_advance_deposit":false,"is_no_show":false,"number_of_nights":4,"property_phone":"4155559876","room_rate":"10000","room_tax":"1500"},"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":45000,"amount_requested":45000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:05:03.69Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUvjH7MLwEpT3pkVmu7VvNaQ","merchant_identity":"IDvLLvjXjjKQYXFdrYWvVfWJ","messages":[],"network_details":{"brand":"VISA","authorization_code":"111981"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{"order_id":"ORD-123"},"trace_id":"acc65ff0-0c15-4334-8c76-5e1fdd28bfaa","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUfcQv7Mat2YqvYK9pF7xWeU"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvLLvjXjjKQYXFdrYWvVfWJ"}}},"key":"Authorization - Lodging","summary":"Authorization - Lodging","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Lodging"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Gaming":{"value":{"id":"AU27jmFXPEG31HL5qUx1xtyY","created_at":"2026-09-25T20:05:01.41Z","updated_at":"2026-09-25T20:05:01.41Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:05:01.41Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmKTKuetVV1MQ5Cq6rjWA5j","merchant_identity":"IDsuVDUYpUS2pzqQVsuUZzNH","messages":[],"network_details":{"brand":"VISA","authorization_code":"597742"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"c68449a7-944a-422e-a22f-46e6c27bb183","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AU27jmFXPEG31HL5qUx1xtyY"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDsuVDUYpUS2pzqQVsuUZzNH"}}},"key":"Authorization - Gaming","summary":"Authorization - Gaming","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Gaming"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 2 Processing":{"value":{"id":"AUpkHPontypnra6ixQ6nKaCD","created_at":"2026-09-25T20:05:02.19Z","updated_at":"2026-09-25T20:05:02.19Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":null,"destination_country_code":null,"destination_postal_code":null,"discount_amount":null,"invoice_reference_number":null,"order_date":null,"sales_tax":200,"sales_tax_finix_generated":null,"ship_from_postal_code":null,"shipping_amount":null,"tax_exempt":false,"item_data":[]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-02T20:05:02.19Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":{"brand":"MASTERCARD","authorization_code":"899854"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIs3rzrjP9orEjBwtJjhxEjL","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"0e189372-9f27-4475-80f0-9e755be33d3b","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUpkHPontypnra6ixQ6nKaCD"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"}}},"key":"Authorization - Level 2 Processing","summary":"Authorization - Level 2 Processing","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 2 Processing"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 3 Processing":{"value":{"id":"AUzck2De5WUgJY1kCUkwLtT","created_at":"2026-10-27T20:24:47.60Z","updated_at":"2026-10-27T20:24:47.60Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":0,"destination_country_code":null,"destination_postal_code":null,"discount_amount":100,"invoice_reference_number":null,"order_date":null,"sales_tax":null,"sales_tax_finix_generated":90,"ship_from_postal_code":null,"shipping_amount":100,"tax_exempt":false,"item_data":[{"cost_per_unit":500,"item_description":"IT Network Assessment","item_discount_amount":100,"merchant_product_code":"SVC-NET-ASMT","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":440,"unit_of_measure":"HUR","commodity_code":"175-62-20","sales_tax_amount":40,"sales_tax_rate":0.1},{"cost_per_unit":500,"item_description":"USB-C Charging Cable 6ft","item_discount_amount":0,"merchant_product_code":"CBL-USBC-6FT","quantity":1,"amount_excluding_sales_tax":500,"amount_including_sales_tax":550,"unit_of_measure":"EA","commodity_code":"207-72-54","sales_tax_amount":50,"sales_tax_rate":0.1}]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":990,"amount_requested":990,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-11-06T20:24:47.60Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":{"brand":"VISA","authorization_code":"517554"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"9670df3e-bbe6-4def-a2a4-a59b99e056a7","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUzck2De5WUgJY1kCUkwLtT"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"}}},"key":"Authorization - Level 3 Processing","summary":"Authorization - Level 3 Processing","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Level 3 Processing"},"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Recurring or Unscheduled":{"value":{"id":"AUwAWS8PhNoTWkmvyANdhgm2","created_at":"2026-09-25T20:05:05.08Z","updated_at":"2026-09-25T20:05:05.08Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","credential_on_file":{"initial_transfer_id":"TRwWJd8NPvfaxp7nqnud8etF","type":"RECURRING"},"currency":"USD","expires_at":"2026-10-05T20:05:05.08Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"574623"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"21948f78-33dc-4f7a-bd85-641e344e2d19","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUwAWS8PhNoTWkmvyANdhgm2"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},"key":"Authorization - Recurring or Unscheduled","summary":"Authorization - Recurring or Unscheduled","id":"paths/~1authorizations/post/responses/201/content/application~1json/examples/Authorization - Recurring or Unscheduled"},"paths/~1authorizations/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1authorizations/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1authorizations/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1authorizations/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1authorizations/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1authorizations/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1authorizations/post/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"04235757babaa8ad","message":"Merchant was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1authorizations/post/responses/404/content/application~1json/examples/Not found"},"paths/~1authorizations/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1authorizations/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1authorizations/post/responses/422/content/application~1json/examples/item_data tax values incorrect":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"34af38fb06cfe836","message":"item_data tax value(s) are incorrect. When passing item_data tax values, the following must be true: amount_including_sales_tax - amount_excluding_sales_tax >= 0","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"item_data tax values incorrect","summary":"item_data tax values incorrect","id":"paths/~1authorizations/post/responses/422/content/application~1json/examples/item_data tax values incorrect"},"paths/~1authorizations/post/responses/422/content/application~1json/examples/Unit of measure too long":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"c47f3d8e876fecc6","message":"unit_of_measure is 4 characters and the maximum character length is 3.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Unit of measure too long","summary":"Unit of measure too long","id":"paths/~1authorizations/post/responses/422/content/application~1json/examples/Unit of measure too long"},"paths/~1authorizations/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"9a0d5f31c8b47e26","message":"3d_secure_authentication and 3d_secure_session_c5dR7Wk1H392XJq6tzNCUb cannot be used together.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"3d_secure_authentication and 3d_secure_session used together","summary":"3d_secure_authentication and 3d_secure_session used together","id":"paths/~1authorizations/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together"},"paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"1f6b8c02ae934d57","message":"3d_secure_session_c5dR7Wk1H392XJq6tzNCUb is associated with a different Payment Instrument than the source provided.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"3D Secure Session belongs to a different Payment Instrument","summary":"3D Secure Session belongs to a different Payment Instrument","id":"paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument"},"paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session already used":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"4c73e9a15d08b2f6","message":"A transaction with 3d_secure_session_c5dR7Wk1H392XJq6tzNCUb has already been submitted.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"3D Secure Session already used","summary":"3D Secure Session already used","id":"paths/~1authorizations/post/responses/422/content/application~1json/examples/3D Secure Session already used"},"paths/~1authorizations/get/responses/200/content/application~1json/examples/List of Authorizations":{"value":{"_embedded":{"authorizations":[{"id":"AU7gwXbxWSWHhGjqz6HGtXPV","created_at":"2026-09-25T20:36:23.45Z","updated_at":"2026-09-25T20:37:03.55Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:36:23.45Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":true,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"064062"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"1b0d63c1-797a-4521-879a-d55ad8333c7d","transfer":null,"void_state":"SUCCEEDED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AU7gwXbxWSWHhGjqz6HGtXPV"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},{"id":"AUwzYQa2LGxWnQZrYPB7yyMW","created_at":"2026-09-25T20:36:22.03Z","updated_at":"2026-09-25T20:36:22.80Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:36:22.03Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"060735"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"6b4d9845-9049-4aef-8ce3-220f5469dbff","transfer":"TR6E1NUyaPFTdnNDgoaR88j","void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUwzYQa2LGxWnQZrYPB7yyMW"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR6E1NUyaPFTdnNDgoaR88j"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},{"id":"AUbWeT4YfQRgjKwfXk1pwb5E","created_at":"2026-09-25T20:36:20.39Z","updated_at":"2026-09-25T20:36:21.28Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:36:20.39Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"004086"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"6aa71f62-504c-40e3-8598-c074f98b3183","transfer":"TRj2ac3ocT3UKfSCvNt2eGFr","void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUbWeT4YfQRgjKwfXk1pwb5E"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRj2ac3ocT3UKfSCvNt2eGFr"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations?limit=3&state=SUCCEEDED"},"next":{"href":"https://finix.sandbox-payments-api.com/authorizations?limit=3&state=SUCCEEDED&after_cursor=AUbWeT4YfQRgjKwfXk1pwb5E"}},"page":{"limit":3,"next_cursor":"AUbWeT4YfQRgjKwfXk1pwb5E"}},"key":"List of Authorizations","summary":"List of Authorizations","id":"paths/~1authorizations/get/responses/200/content/application~1json/examples/List of Authorizations"},"paths/~1authorizations/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1authorizations/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1authorizations/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1authorizations/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1authorizations/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1authorizations/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1authorizations/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1authorizations/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1authorizations~1{authorization_id}/get/responses/200/content/application~1json/examples/Authorization":{"value":{"id":"AUgUHQYgKgR2jR2J2x3nav9Z","created_at":"2026-09-17T18:00:37.16Z","updated_at":"2026-09-17T18:00:37.16Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":{"convenience_amount":10,"surcharge_amount":0,"rent_surcharge_amount":0},"additional_healthcare_data":{"clinic_amount":50,"dental_amount":200,"prescription_amount":300,"vision_amount":300},"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":10,"destination_country_code":null,"destination_postal_code":null,"discount_amount":100,"invoice_reference_number":null,"order_date":null,"sales_tax":null,"sales_tax_finix_generated":200,"ship_from_postal_code":null,"shipping_amount":100,"tax_exempt":false,"item_data":[{"cost_per_unit":500,"item_description":"Consulting Services","item_discount_amount":100,"merchant_product_code":"SKU 12312","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"BX","commodity_code":"175-62-20","sales_tax_amount":100,"sales_tax_rate":0.25},{"cost_per_unit":500,"item_description":"GPT-5.6","item_discount_amount":0,"merchant_product_code":"SKU 2222","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"CTN","commodity_code":"207-72-54","sales_tax_amount":100,"sales_tax_rate":0.25}]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-09-27T18:00:37.16Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"426389"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{"order_id":"ORD-123"},"trace_id":"0c949ef1-764d-4bc4-94f4-f39436eac304","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUgUHQYgKgR2jR2J2x3nav9Z"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},"key":"Authorization","summary":"Authorization","id":"paths/~1authorizations~1{authorization_id}/get/responses/200/content/application~1json/examples/Authorization"},"paths/~1authorizations~1{authorization_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1authorizations~1{authorization_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1authorizations~1{authorization_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1authorizations~1{authorization_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1authorizations~1{authorization_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"AUg8unYpnWBEY1AdVUDkdQYJ was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1authorizations~1{authorization_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1authorizations~1{authorization_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1authorizations~1{authorization_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization":{"value":{"capture_amount":100,"fee":0},"key":"Capture Authorization","summary":"Capture Authorization","id":"paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization"},"paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Card Present Authorization":{"value":{"capture_amount":150},"key":"Capture Card Present Authorization","summary":"Capture Card Present Authorization","id":"paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Card Present Authorization"},"paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization with Split Transfers":{"value":{"capture_amount":100,"split_transfers":[{"amount":60,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq"},{"amount":40,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm"}]},"key":"Capture Authorization with Split Transfers","summary":"Capture Authorization with Split Transfers","id":"paths/~1authorizations~1{authorization_id}/put/requestBody/content/application~1json/examples/Capture Authorization with Split Transfers"},"paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization":{"value":{"id":"AUbWeT4YfQRgjKwfXk1pwb5E","created_at":"2026-09-25T20:36:20.39Z","updated_at":"2026-09-25T20:36:21.28Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:36:20.39Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"004086"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"6aa71f62-504c-40e3-8598-c074f98b3183","transfer":"TRj2ac3ocT3UKfSCvNt2eGFr","void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUbWeT4YfQRgjKwfXk1pwb5E"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRj2ac3ocT3UKfSCvNt2eGFr"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},"key":"Capture Authorization","summary":"Capture Authorization","id":"paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization"},"paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Card Present Authorization":{"value":{"id":"AUgEVBSEkyFdEJ4ur8UbBWw6","created_at":"2026-09-28T20:30:39.71Z","updated_at":"2026-09-28T20:30:39.71Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":150,"amount_requested":150,"application":"APc9vhYcPsRuTSpKD9KpMtPe","card_present_details":{"approval_code":"135761","brand":"VISA","digital_signature_file_id":null,"emv_data":{"application_identifier":"A0000000031010","application_label":"VISA CREDIT","application_preferred_name":null,"application_transaction_counter":"0033","cryptogram":"ARQC CBEE0E04EDD490A9","issuer_code_table_index":null,"network_emv_response":null,"pin_verified":false,"tags":null},"entry_mode":"CONTACTLESS","masked_account_number":"476173******0010","name":null,"payment_type":"CREDIT"},"created_via":"CARD_PRESENT_SEMI_INTEGRATED_API","currency":"USD","device":"DVhCtTEMVHnDPFMh2KQLrFSi","expires_at":"2026-10-05T20:30:39.71Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmFY9PWbqJPGtQEN7RXdFAb","merchant_identity":"IDvEVPqD9rnfLCAGnLJphyGT","messages":[],"network_details":{"brand":"VISA","authorization_code":"135761"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":"PIbHf6aXRrZQAHYiu1UeKB93","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"68cf2b9c-0b94-458a-9167-b06903bb5136","transfer":null,"void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUgEVBSEkyFdEJ4ur8UbBWw6"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"device":{"href":"https://finix.sandbox-payments-api.com/devices/DVhCtTEMVHnDPFMh2KQLrFSi"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvEVPqD9rnfLCAGnLJphyGT"}}},"key":"Capture Card Present Authorization","summary":"Capture Card Present Authorization","id":"paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Card Present Authorization"},"paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization with Split Transfers":{"value":{"id":"AUwzYQa2LGxWnQZrYPB7yyMW","created_at":"2026-09-25T20:36:22.03Z","updated_at":"2026-09-25T20:36:22.80Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:36:22.03Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":false,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"060735"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"6b4d9845-9049-4aef-8ce3-220f5469dbff","transfer":"TR6E1NUyaPFTdnNDgoaR88j","void_state":"UNATTEMPTED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUwzYQa2LGxWnQZrYPB7yyMW"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR6E1NUyaPFTdnNDgoaR88j"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},"key":"Capture Authorization with Split Transfers","summary":"Capture Authorization with Split Transfers","id":"paths/~1authorizations~1{authorization_id}/put/responses/200/content/application~1json/examples/Capture Authorization with Split Transfers"},"paths/~1authorizations~1{authorization_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1authorizations~1{authorization_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1authorizations~1{authorization_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1authorizations~1{authorization_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1authorizations~1{authorization_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1authorizations~1{authorization_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1authorizations~1{authorization_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"AUg8unYpnWBEY1AdVUDkdQYJ was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1authorizations~1{authorization_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1authorizations~1{authorization_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1authorizations~1{authorization_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Incorrect sum of split_transfer amounts":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"e79e44a5bd57ae33","message":"the sum of all split_transfer amounts must be equal to '100'","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Incorrect sum of split_transfer amounts","summary":"Incorrect sum of split_transfer amounts","id":"paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Incorrect sum of split_transfer amounts"},"paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Amount cannot be greater than the original authorization":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_AMOUNT","logref":"e79e44a5bd57ae33","message":"Cannot capture an amount greater than the original authorization amount","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Amount cannot be greater than the original authorization","summary":"Amount cannot be greater than the original authorization","id":"paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Amount cannot be greater than the original authorization"},"paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Fee more than captured amount":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"e79e44a5bd57ae33","message":"fee should be less than the capture_amount.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUg8unYpnWBEY1AdVUDkdQYJ"}}}]}},"key":"Fee more than captured amount","summary":"Fee more than captured amount","id":"paths/~1authorizations~1{authorization_id}/put/responses/422/content/application~1json/examples/Fee more than captured amount"},"paths/~1authorizations~1{authorization_id_void_to}/put/requestBody/content/application~1json/examples/Void an Authorization":{"value":{"void_me":true},"key":"Void an Authorization","summary":"Void an Authorization","id":"paths/~1authorizations~1{authorization_id_void_to}/put/requestBody/content/application~1json/examples/Void an Authorization"},"paths/~1authorizations~1{authorization_id_void_to}/put/responses/200/content/application~1json/examples/Authorization":{"value":{"id":"AU7gwXbxWSWHhGjqz6HGtXPV","created_at":"2026-09-25T20:36:23.45Z","updated_at":"2026-09-25T20:36:24.09Z","3d_secure_session":null,"3ds_redirect_url":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","expires_at":"2026-10-05T20:36:23.45Z","failure_code":null,"failure_message":null,"idempotency_id":null,"ip_address_details":null,"is_void":true,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"064062"},"raw":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","state":"SUCCEEDED","supplemental_fee":null,"tags":{},"trace_id":"1b0d63c1-797a-4521-879a-d55ad8333c7d","transfer":null,"void_state":"PENDING","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AU7gwXbxWSWHhGjqz6HGtXPV"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"}}},"key":"Authorization","summary":"Authorization","id":"paths/~1authorizations~1{authorization_id_void_to}/put/responses/200/content/application~1json/examples/Authorization"},"paths/~1authorizations~1{authorization_id_void_to}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUnubzehgQfqcvJpoxhqja7k"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1authorizations~1{authorization_id_void_to}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1authorizations~1{authorization_id_void_to}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUnubzehgQfqcvJpoxhqja7k"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1authorizations~1{authorization_id_void_to}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1authorizations~1{authorization_id_void_to}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUnubzehgQfqcvJpoxhqja7k"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1authorizations~1{authorization_id_void_to}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1authorizations~1{authorization_id_void_to}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"AUnubzehgQfqcvJpoxhqja7k was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUnubzehgQfqcvJpoxhqja7k"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1authorizations~1{authorization_id_void_to}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1authorizations~1{authorization_id_void_to}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUnubzehgQfqcvJpoxhqja7k"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1authorizations~1{authorization_id_void_to}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1authorizations~1{authorization_id_void_to}/put/responses/422/content/application~1json/examples/Authorization already captured":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"60598e10ccb7e077","message":"Authorization 'AUrUgnqNfHiRXzrtDgXGkPcC' is already captured","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/authorizations/AUrUgnqNfHiRXzrtDgXGkPcC"}}}]}},"key":"Authorization already captured","summary":"Authorization already captured","id":"paths/~1authorizations~1{authorization_id_void_to}/put/responses/422/content/application~1json/examples/Authorization already captured"},"paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Unsigned Compliance Form":{"value":{"id":"cf_uwErNm23TKYNEiqrEdJK59","created_at":"2025-07-07T18:05:01.96471Z","updated_at":"2025-11-18T22:49:40.269788Z","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","application":"APc9vhYcPsRuTSpKD9KpMtPe","type":"PCI_SAQ_A","version":"2018.10","valid_from":"2025-09-09T23:17:43.041004Z","valid_until":"2026-09-09T23:17:43.041005Z","tags":{},"pci_saq_a":{"name":"John Doe","signed_at":"2022-03-18T16:42:55Z","user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)","ip_address":"42.1.1.113","is_accepted":true,"title":"CTO"},"due_at":"2025-10-05T18:05:01.94105Z","compliance_form_template":"cft_n6BfvWBVe4iK1HC4n9qN2t","files":{"unsigned_file":"FILE_uyntoF5Y4LDrMDJtA9ujd6","signed_file":null},"state":"INCOMPLETE"},"key":"Unsigned Compliance Form","summary":"Unsigned Compliance Form","id":"paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Unsigned Compliance Form"},"paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Signed Compliance Form":{"value":{"id":"cf_uwErNm23TKYNEiqrEdJK59","created_at":"2025-07-07T18:05:01.96471Z","updated_at":"2025-11-18T22:49:40.269788Z","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","application":"APc9vhYcPsRuTSpKD9KpMtPe","type":"PCI_SAQ_A","version":"2018.10","valid_from":"2025-09-09T23:17:43.041004Z","valid_until":"2026-09-09T23:17:43.041005Z","tags":{},"pci_saq_a":{"name":"John Doe","signed_at":"2022-03-18T16:42:55Z","user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)","ip_address":"42.1.1.113","is_accepted":true,"title":"CTO"},"due_at":"2025-10-05T18:05:01.94105Z","compliance_form_template":"cft_n6BfvWBVe4iK1HC4n9qN2t","files":{"unsigned_file":"FILE_uyntoF5Y4LDrMDJtA9ujd6","signed_file":"FILE_6U26h97cpuKmxqdE27KZh7"},"state":"COMPLETE"},"key":"Signed Compliance Form","summary":"Signed Compliance Form","id":"paths/~1compliance_forms~1{compliance_form_id}/get/responses/200/content/application~1json/examples/Signed Compliance Form"},"paths/~1compliance_forms~1{compliance_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1compliance_forms~1{compliance_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1compliance_forms~1{compliance_form_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1compliance_forms~1{compliance_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1compliance_forms~1{compliance_form_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"cf_uwErNm23TKYNEiqrEdJK59 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1compliance_forms~1{compliance_form_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1compliance_forms~1{compliance_form_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1compliance_forms~1{compliance_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1compliance_forms~1{compliance_form_id}/put/requestBody/content/application~1json/examples/Complete a Compliance Form":{"value":{"pci_saq_a":{"ip_address":"42.1.1.113","name":"John Doe","signed_at":"2022-03-18T16:42:55Z","title":"CTO","user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)"}},"key":"Complete a Compliance Form","summary":"Complete a Compliance Form","id":"paths/~1compliance_forms~1{compliance_form_id}/put/requestBody/content/application~1json/examples/Complete a Compliance Form"},"paths/~1compliance_forms~1{compliance_form_id}/put/responses/200/content/application~1json/examples/Completed Compliance Form":{"value":{"id":"cf_uwErNm23TKYNEiqrEdJK59","created_at":"2025-07-07T18:05:01.96471Z","updated_at":"2025-11-18T22:49:40.269788Z","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","application":"APc9vhYcPsRuTSpKD9KpMtPe","type":"PCI_SAQ_A","version":"2018.10","valid_from":"2025-09-09T23:17:43.041004Z","valid_until":"2026-09-09T23:17:43.041005Z","tags":{},"pci_saq_a":{"name":"John Doe","signed_at":"2022-03-18T16:42:55Z","user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10 _14_6)","ip_address":"42.1.1.113","is_accepted":true,"title":"CTO"},"due_at":"2025-10-05T18:05:01.94105Z","compliance_form_template":"cft_n6BfvWBVe4iK1HC4n9qN2t","files":{"unsigned_file":"FILE_uyntoF5Y4LDrMDJtA9ujd6","signed_file":"FILE_6U26h97cpuKmxqdE27KZh7"},"state":"COMPLETE"},"key":"Completed Compliance Form","summary":"Completed Compliance Form","id":"paths/~1compliance_forms~1{compliance_form_id}/put/responses/200/content/application~1json/examples/Completed Compliance Form"},"paths/~1compliance_forms~1{compliance_form_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1compliance_forms~1{compliance_form_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1compliance_forms~1{compliance_form_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1compliance_forms~1{compliance_form_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1compliance_forms~1{compliance_form_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1compliance_forms~1{compliance_form_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1compliance_forms~1{compliance_form_id}/put/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"cf_uwErNm23TKYNEiqrEdJK59 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1compliance_forms~1{compliance_form_id}/put/responses/404/content/application~1json/examples/NotFound"},"paths/~1compliance_forms~1{compliance_form_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms/cf_uwErNm23TKYNEiqrEdJK59"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1compliance_forms~1{compliance_form_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1compliance_forms/get/responses/200/content/application~1json/examples/List of Compliance Forms":{"value":{"_embedded":{"compliance_forms":[{"id":"cf_eAw7GFzu94oyvsCT6NMcG4","created_at":"2025-07-17T11:59:02.157273Z","updated_at":"2025-11-04T22:21:02.368641Z","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","application":"APc9vhYcPsRuTSpKD9KpMtPe","type":"PCI_SAQ_A","version":"2018.10","valid_from":"2025-11-04T22:20:06.061944Z","valid_until":"2026-11-04T22:20:06.061945Z","tags":{},"pci_saq_a":{"name":"Paul Dirant","signed_at":"2025-11-04T22:20:05Z","user_agent":null,"ip_address":null,"is_accepted":true,"title":"CEO"},"due_at":"2025-10-15T11:59:02.137385Z","compliance_form_template":"cft_n6BfvWBVe4iK1HC4n9qN2t","files":{"unsigned_file":"FILE_eCn9r1Bg25vk9V4pZCF7KQ","signed_file":"FILE_e9s71AV9ygRfNa7CaUsgvG"},"state":"COMPLETE"}]},"page":{"next_cursor":null,"limit":3}},"key":"List of Compliance Forms","summary":"List of Compliance Forms","id":"paths/~1compliance_forms/get/responses/200/content/application~1json/examples/List of Compliance Forms"},"paths/~1compliance_forms/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1compliance_forms/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1compliance_forms/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1compliance_forms/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1compliance_forms/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1compliance_forms/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1compliance_forms/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/compliance_forms"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1compliance_forms/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1devices/get/responses/200/content/application~1json/examples/List of Devices":{"value":{"_embedded":{"devices":[{"id":"DV8oMUP5ME1rnxpgoXn5V2GD","created_at":"2026-09-28T20:31:57.874129Z","updated_at":"2026-09-28T20:31:57.874129Z","android_version":"10","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":300,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":true,"firmware_version":"PayDroid_10.0.0_Eucalyptus_V20.1.33_20260407","idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","payment_app_version":"5.9.0","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DV8oMUP5ME1rnxpgoXn5V2GD"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},{"id":"DVjA9EmYhyX91C341naHVoAN","created_at":"2026-09-28T19:15:20.801742Z","updated_at":"2026-09-28T19:15:20.801742Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"iOS Tap to Pay device","enabled":true,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUsdGLyqscKZLsSfA5eeF4NJ","model":"IOS_TAP_TO_PAY","name":"iPhone Tap to Pay - Finix Flowers","serial_number":"d1d16d5551894fef916014e0aa8597ed63722aa0a8f0e424421cf6702fddba55","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVjA9EmYhyX91C341naHVoAN"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUsdGLyqscKZLsSfA5eeF4NJ"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},{"id":"DVfdTeWPfsFvXqkmBCh9Gex3","created_at":"2026-09-28T19:15:07.135371Z","updated_at":"2026-09-28T19:15:07.135371Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"iOS Tap to Pay device","enabled":true,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUjghdVHAFcQB3H9CJvQPSMt","model":"IOS_TAP_TO_PAY","name":"iPhone Tap to Pay - Finix Flowers","serial_number":"d1d16d5551894fef916014e0aa8597ed63722aa0a8f0e424421cf6702fddba55","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVfdTeWPfsFvXqkmBCh9Gex3"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUjghdVHAFcQB3H9CJvQPSMt"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices?limit=3&enabled=true"},"next":{"href":"https://finix.sandbox-payments-api.com/devices?limit=3&enabled=true&after_cursor=DVfdTeWPfsFvXqkmBCh9Gex3"}},"page":{"limit":3,"next_cursor":"DVfdTeWPfsFvXqkmBCh9Gex3"}},"key":"List of Devices","summary":"List of Devices","id":"paths/~1devices/get/responses/200/content/application~1json/examples/List of Devices"},"paths/~1devices/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1devices/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1devices/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1devices/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1devices/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1devices/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1devices/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1devices/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1devices~1{device_id}/get/responses/200/content/application~1json/examples/Device":{"value":{"id":"DV8oMUP5ME1rnxpgoXn5V2GD","created_at":"2026-09-28T20:31:57.874129Z","updated_at":"2026-09-28T20:31:57.874129Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":false,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DV8oMUP5ME1rnxpgoXn5V2GD"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Device","summary":"Device","id":"paths/~1devices~1{device_id}/get/responses/200/content/application~1json/examples/Device"},"paths/~1devices~1{device_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1devices~1{device_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1devices~1{device_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1devices~1{device_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1devices~1{device_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DVoDo7F6yYCnX2d6Fj9hvsd was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1devices~1{device_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1devices~1{device_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1devices~1{device_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Activate":{"value":{"action":"ACTIVATE"},"key":"Device - Activate","summary":"Device - Activate","id":"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Activate"},"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Cancel":{"value":{"action":"CANCEL"},"key":"Device - Cancel","summary":"Device - Cancel","id":"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Cancel"},"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Deactivate":{"value":{"action":"DEACTIVATE"},"key":"Device - Deactivate","summary":"Device - Deactivate","id":"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Deactivate"},"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Idle File Image and Message":{"value":{"configuration":{"idle_image_file_id":"FILE_bFSshq8CFdm1wyTJQztys7","idle_message":"Device is idle"}},"key":"Device - Update Idle File Image and Message","summary":"Device - Update Idle File Image and Message","id":"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Idle File Image and Message"},"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Surcharges":{"value":{"configuration":{"surcharge_basis_points":300}},"key":"Device - Update Surcharges","summary":"Device - Update Surcharges","id":"paths/~1devices~1{device_id}/put/requestBody/content/application~1json/examples/Device - Update Surcharges"},"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Activate":{"value":{"id":"DV8oMUP5ME1rnxpgoXn5V2GD","created_at":"2026-09-28T20:31:57.874129Z","updated_at":"2026-09-28T20:31:57.874129Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":true,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DV8oMUP5ME1rnxpgoXn5V2GD"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Device - Activate","summary":"Device - Activate","id":"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Activate"},"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Cancel":{"value":{"id":"DVhCtTEMVHnDPFMh2KQLrFSi","created_at":"2026-09-28T20:29:45.916631Z","updated_at":"2026-09-28T20:29:45.916631Z","android_version":"10","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":"FILE_bFSshq8CFdm1wyTJQztys7","idle_message":"Device is idle","prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":true,"firmware_version":"PayDroid_10.0.0_Eucalyptus_V20.1.33_20260407","idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUmFY9PWbqJPGtQEN7RXdFAb","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","payment_app_version":"5.9.0","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVhCtTEMVHnDPFMh2KQLrFSi"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUmFY9PWbqJPGtQEN7RXdFAb"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Device - Cancel","summary":"Device - Cancel","id":"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Cancel"},"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Deactivate":{"value":{"id":"DVtCa1gxCUfkZDoZkG1uvqHt","created_at":"2026-09-25T21:10:21.542520Z","updated_at":"2026-09-25T21:10:21.542520Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":false,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUwiQFyoZCVwmn2t6SwUciQH","model":"PAX_A800","name":"PAX_A800","serial_number":"1904626094","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVtCa1gxCUfkZDoZkG1uvqHt"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwiQFyoZCVwmn2t6SwUciQH"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Device - Deactivate","summary":"Device - Deactivate","id":"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Deactivate"},"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Idle File Image and Message":{"value":{"id":"DVhCtTEMVHnDPFMh2KQLrFSi","created_at":"2026-09-28T20:29:45.916631Z","updated_at":"2026-09-28T20:29:45.916631Z","android_version":"10","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":"FILE_bFSshq8CFdm1wyTJQztys7","idle_message":"Device is idle","prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":true,"firmware_version":"PayDroid_10.0.0_Eucalyptus_V20.1.33_20260407","idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUmFY9PWbqJPGtQEN7RXdFAb","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","payment_app_version":"5.9.0","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVhCtTEMVHnDPFMh2KQLrFSi"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUmFY9PWbqJPGtQEN7RXdFAb"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Device - Update Idle File Image and Message","summary":"Device - Update Idle File Image and Message","id":"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Idle File Image and Message"},"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Surcharges":{"value":{"id":"DV8oMUP5ME1rnxpgoXn5V2GD","created_at":"2026-09-28T20:31:57.874129Z","updated_at":"2026-09-28T20:31:57.874129Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":300,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":true,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DV8oMUP5ME1rnxpgoXn5V2GD"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Device - Update Surcharges","summary":"Device - Update Surcharges","id":"paths/~1devices~1{device_id}/put/responses/200/content/application~1json/examples/Device - Update Surcharges"},"paths/~1devices~1{device_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1devices~1{device_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1devices~1{device_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1devices~1{device_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1devices~1{device_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1devices~1{device_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1devices~1{device_id}/put/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DVoDo7F6yYCnX2d6Fj9hvsd was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1devices~1{device_id}/put/responses/404/content/application~1json/examples/NotFound"},"paths/~1devices~1{device_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1devices~1{device_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1devices~1{device_id_connection}/get/responses/200/content/application~1json/examples/Device":{"value":{"id":"DVcazsRGCXuRgxYAqwkbvvci","created_at":"2026-09-28T21:13:37.292622Z","updated_at":"2026-09-28T21:13:37.292622Z","android_version":"10","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":"FILE_fJnt6o1h36YHXdqX2Hidwn","idle_message":"Device is idle","prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"connection":"Open","description":"Cashier One","enabled":true,"firmware_version":"PayDroid_10.0.0_Eucalyptus_V20.1.33_20260407","idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MU54k9jqhxipR4TV5UjD4x5u","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","payment_app_version":"5.9.0","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVcazsRGCXuRgxYAqwkbvvci"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU54k9jqhxipR4TV5UjD4x5u"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Device","summary":"Device","id":"paths/~1devices~1{device_id_connection}/get/responses/200/content/application~1json/examples/Device"},"paths/~1devices~1{device_id_connection}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1devices~1{device_id_connection}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1devices~1{device_id_connection}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1devices~1{device_id_connection}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1devices~1{device_id_connection}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DVoDo7F6yYCnX2d6Fj9hvsd was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1devices~1{device_id_connection}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1devices~1{device_id_connection}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1devices~1{device_id_connection}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1devices~1{device_id}~1device_metrics/get/responses/200/content/application~1json/examples/List of Devices":{"value":{"_embedded":{"devices":[{"id":"DV8oMUP5ME1rnxpgoXn5V2GD","created_at":"2026-09-28T20:31:57.874129Z","updated_at":"2026-09-28T20:31:57.874129Z","android_version":"10","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":300,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":true,"firmware_version":"PayDroid_10.0.0_Eucalyptus_V20.1.33_20260407","idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","payment_app_version":"5.9.0","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DV8oMUP5ME1rnxpgoXn5V2GD"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},{"id":"DVjA9EmYhyX91C341naHVoAN","created_at":"2026-09-28T19:15:20.801742Z","updated_at":"2026-09-28T19:15:20.801742Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"iOS Tap to Pay device","enabled":true,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUsdGLyqscKZLsSfA5eeF4NJ","model":"IOS_TAP_TO_PAY","name":"iPhone Tap to Pay - Finix Flowers","serial_number":"d1d16d5551894fef916014e0aa8597ed63722aa0a8f0e424421cf6702fddba55","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVjA9EmYhyX91C341naHVoAN"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUsdGLyqscKZLsSfA5eeF4NJ"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},{"id":"DVfdTeWPfsFvXqkmBCh9Gex3","created_at":"2026-09-28T19:15:07.135371Z","updated_at":"2026-09-28T19:15:07.135371Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"iOS Tap to Pay device","enabled":true,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUjghdVHAFcQB3H9CJvQPSMt","model":"IOS_TAP_TO_PAY","name":"iPhone Tap to Pay - Finix Flowers","serial_number":"d1d16d5551894fef916014e0aa8597ed63722aa0a8f0e424421cf6702fddba55","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVfdTeWPfsFvXqkmBCh9Gex3"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUjghdVHAFcQB3H9CJvQPSMt"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices?limit=3&enabled=true"},"next":{"href":"https://finix.sandbox-payments-api.com/devices?limit=3&enabled=true&after_cursor=DVfdTeWPfsFvXqkmBCh9Gex3"}},"page":{"limit":3,"next_cursor":"DVfdTeWPfsFvXqkmBCh9Gex3"}},"key":"List of Devices","summary":"List of Devices","id":"paths/~1devices~1{device_id}~1device_metrics/get/responses/200/content/application~1json/examples/List of Devices"},"paths/~1devices~1{device_id}~1device_metrics/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd/device_metrics"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1devices~1{device_id}~1device_metrics/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1devices~1{device_id}~1device_metrics/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd/device_metrics"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1devices~1{device_id}~1device_metrics/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1devices~1{device_id}~1device_metrics/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd/device_metrics"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1devices~1{device_id}~1device_metrics/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1devices~1{device_id}~1device_metrics/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"1b633873a40e12448027912817784122","message":"Invalid value for query param power_battery_temperature_fahrenheit with value: true","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVoDo7F6yYCnX2d6Fj9hvsd/device_metrics"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1devices~1{device_id}~1device_metrics/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY":{"value":{"app_bundle_id":"com.finix.FinixCheckout","description":"iOS Tap to Pay device","model":"IOS_TAP_TO_PAY","name":"iPhone Tap to Pay - Michael Johnson","serial_number":"cdb7ac638cb455f6d85e791115c0a4fd3cf6cbcdb874cbf30c871bc312zy3abc"},"key":"Create a Device - Model IOS_TAP_TO_PAY","summary":"Create a Device - Model IOS_TAP_TO_PAY","id":"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY"},"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A800":{"value":{"configuration":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"prompt_amount_confirmation":true,"prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"tipping_details":{"allow_custom_tip":true,"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","integration_mode":"PAYMENT_APP","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","serial_number":"2210172205"},"key":"Create a Device - Model PAX_A800","summary":"Create a Device - Model PAX_A800","id":"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A800"},"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A920PRO":{"value":{"configuration":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"prompt_amount_confirmation":true,"prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"tipping_details":{"allow_custom_tip":true,"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier Two","integration_mode":"PAYMENT_APP","model":"PAX_A920PRO","name":"My PAX_A920PRO Finix Device","serial_number":"1904626094"},"key":"Create a Device - Model PAX_A920PRO","summary":"Create a Device - Model PAX_A920PRO","id":"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_A920PRO"},"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_D135":{"value":{"configuration":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"prompt_amount_confirmation":true,"prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"tipping_details":{"allow_custom_tip":true,"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier Three","integration_mode":"PAYMENT_APP","model":"PAX_D135","name":"My PAX_D135 Finix Device","serial_number":"1904626094"},"key":"Create a Device - Model PAX_D135","summary":"Create a Device - Model PAX_D135","id":"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_D135"},"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_IM30":{"value":{"configuration":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"prompt_amount_confirmation":true,"prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"tipping_details":{"allow_custom_tip":true,"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Kiosk Three","integration_mode":"PAYMENT_APP","model":"PAX_IM30","name":"My PAX_IM30 Finix Device","serial_number":"1234567890"},"key":"Create a Device - Model PAX_IM30","summary":"Create a Device - Model PAX_IM30","id":"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Model PAX_IM30"},"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - SDK Mode":{"value":{"description":"Cashier One","integration_mode":"SDK","model":"PAX_A800","name":"My PAX_A800 Finix Device","serial_number":"1904626094"},"key":"Create a Device - SDK Mode","summary":"Create a Device - SDK Mode","id":"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - SDK Mode"},"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode":{"value":{"configuration":{"surcharge_basis_points":300},"description":"Cashier One","integration_mode":"PAYMENT_APP","model":"PAX_A800","name":"My PAX_A800 Finix Device","serial_number":"1904626094"},"key":"Create a Device - Surcharges - Standalone Mode","summary":"Create a Device - Surcharges - Standalone Mode","id":"paths/~1merchants~1{merchant_id}~1devices/post/requestBody/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY":{"value":{"id":"DVhNuqCgLmtHs6ZS9RSucm9x","created_at":"2026-09-25T20:05:14.758628Z","updated_at":"2026-09-25T20:05:14.758628Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"iOS Tap to Pay device","enabled":true,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUiV7ntxfY4eyJxp6E7cZvym","model":"IOS_TAP_TO_PAY","name":"iPhone Tap to Pay - Michael Johnson","serial_number":"cdb7ac638cb455f6d85e791115c0a4fd3cf6cbcdb874cbf30c871bc312zy3abc","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVhNuqCgLmtHs6ZS9RSucm9x"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Create a Device - Model IOS_TAP_TO_PAY","summary":"Create a Device - Model IOS_TAP_TO_PAY","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model IOS_TAP_TO_PAY"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A800":{"value":{"id":"DV8oMUP5ME1rnxpgoXn5V2GD","created_at":"2026-09-28T20:31:57.874129Z","updated_at":"2026-09-28T20:31:57.874129Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":false,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier One","enabled":false,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","model":"PAX_A800","name":"PAX_A800_FRONT_COUNTER","serial_number":"2210172205","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DV8oMUP5ME1rnxpgoXn5V2GD"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Create a Device - Model PAX_A800","summary":"Create a Device - Model PAX_A800","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A800"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A920PRO":{"value":{"id":"DVi2m7ots9aaE2YW9cFNro98","created_at":"2026-09-25T20:05:15.944531Z","updated_at":"2026-09-25T20:05:15.944531Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier Two","enabled":false,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUiV7ntxfY4eyJxp6E7cZvym","model":"PAX_A920PRO","name":"My PAX_A920PRO Finix Device","serial_number":"1904626094","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVi2m7ots9aaE2YW9cFNro98"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Create a Device - Model PAX_A920PRO","summary":"Create a Device - Model PAX_A920PRO","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_A920PRO"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_D135":{"value":{"id":"DVepZf9V5c4tDPFC9qFe4fnD","created_at":"2026-09-25T20:05:16.506309Z","updated_at":"2026-09-25T20:05:16.506309Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Cashier Three","enabled":true,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUiV7ntxfY4eyJxp6E7cZvym","model":"PAX_D135","name":"My PAX_D135 Finix Device","serial_number":"1904626094","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVepZf9V5c4tDPFC9qFe4fnD"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Create a Device - Model PAX_D135","summary":"Create a Device - Model PAX_D135","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_D135"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_IM30":{"value":{"id":"DVdUi9WYEs56L1NrZRomDaLG","created_at":"2026-09-25T20:05:17.063334Z","updated_at":"2026-09-25T20:05:17.063334Z","configuration_details":{"allow_debit":true,"allow_standalone_authorizations":false,"allow_standalone_refunds":false,"allow_standalone_sales":false,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"bypass_device_on_capture":true,"check_for_duplicate_transactions":true,"display_tip_on_receipt":false,"idle_image_file_id":null,"idle_message":null,"prompt_amount_confirmation":true,"prompt_for_signature":"NEVER","prompt_manual_entry":false,"prompt_receipt_confirmation":true,"prompt_tip_on_screen":false,"signature_threshold_amount":10000,"surcharge_basis_points":null,"tipping_details":{"fixed_options":[100,150,200],"percent_options":[18,20,22],"percent_tipping_threshold":0}},"description":"Kiosk Three","enabled":false,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MUiV7ntxfY4eyJxp6E7cZvym","model":"PAX_IM30","name":"My PAX_IM30 Finix Device","serial_number":"1234567890","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVdUi9WYEs56L1NrZRomDaLG"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Create a Device - Model PAX_IM30","summary":"Create a Device - Model PAX_IM30","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Model PAX_IM30"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - SDK Mode":{"value":{"id":"DVjhX8RbhQU3i1vYxYAHWHGP","created_at":"2026-09-25T20:05:17.632944Z","updated_at":"2026-09-25T20:05:17.632944Z","configuration_details":null,"description":"Cashier One","enabled":true,"idle_message":null,"integration_mode":"SDK","merchant":"MUiV7ntxfY4eyJxp6E7cZvym","model":"PAX_A800","name":"My PAX_A800 Finix Device","serial_number":"1904626094","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVjhX8RbhQU3i1vYxYAHWHGP"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Create a Device - SDK Mode","summary":"Create a Device - SDK Mode","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - SDK Mode"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode":{"value":{"id":"DVtqvNrZYGrct4izwJgYikAM","created_at":"2025-05-21T19:02:56.559365Z","updated_at":"2025-05-21T19:02:56.559365Z","configuration_details":{"allow_debit":true,"check_for_duplicate_transactions":true,"prompt_amount_confirmation":true,"prompt_manual_entry":false,"signature_threshold_amount":10000,"bypass_device_on_capture":true,"prompt_receipt_confirmation":true,"display_tip_on_receipt":false,"prompt_tip_on_screen":false,"allow_standalone_authorizations":false,"allow_standalone_sales":false,"allow_standalone_refunds":false,"tipping_details":{"percent_tipping_threshold":0,"percent_options":[18,20,22],"fixed_options":[100,150,200]},"idle_message":null,"idle_image_file_id":null,"automatic_receipt_delivery_methods":null,"available_receipt_methods":null,"prompt_for_signature":"NEVER","surcharge_basis_points":300},"description":"Cashier One","enabled":false,"idle_message":null,"integration_mode":"PAYMENT_APP","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","model":"PAX_A800","name":"My PAX_A800 Finix Device","serial_number":"1904626094","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/devices/DVtqvNrZYGrct4izwJgYikAM"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq"},"transfers":{"href":"https://finix.sandbox-payments-api.com/transfers"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/authorizations"}}},"key":"Create a Device - Surcharges - Standalone Mode","summary":"Create a Device - Surcharges - Standalone Mode","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/201/content/application~1json/examples/Create a Device - Surcharges - Standalone Mode"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/devices"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/devices"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/devices"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/devices"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid model":{"value":{"total":1,"_embedded":{"errors":[{"logref":"968585ceafd48818","message":"Should be one of ANDROID, BBPOS, ELO_PAY7, IPP320, IPP350, ISC250, ISC480, ISMP4, LANE_3600, LANE_3000, LINK_2500, LANE_5000, LANE_7000, LANE_8000, DESK_5000, MOVE_5000, MX915, MX925, PAX_A30, PAX_A35, PAX_A60, PAX_A77, PAX_A800, PAX_A920PRO, PAX_ARIES6, PAX_ARIES8, PAX_D135, PAX_D180, PAX_ELYS, PAX_IM30, SUNMI_P2, SUNMI_P2_SMARTPAD, SUNMI_P3_MIX, THIRD_PARTY_MANAGED, IOS_TAP_TO_PAY.","code":"INVALID_FIELD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/devices"}},"field":"model"}]}},"key":"Invalid model","summary":"Invalid model","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid model"},"paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid integration_mode":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","field":"integration_mode","message":"integration_mode must be one of: PAYMENT_APP, SDK.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/devices"}}}]}},"key":"Invalid integration_mode","summary":"Invalid integration_mode","id":"paths/~1merchants~1{merchant_id}~1devices/post/responses/422/content/application~1json/examples/Invalid integration_mode"},"paths/~1disputes/get/responses/200/content/application~1json/examples/List of Disputes":{"value":{"_embedded":{"disputes":[{"id":"DIgDv9764vkkEVu1suZNCDbR","created_at":"2025-06-25T18:46:18.55Z","updated_at":"2026-09-30T17:44:47.86Z","action":null,"amount":888888,"application":"APc9vhYcPsRuTSpKD9KpMtPe","dispute_details":{"arn":"123"},"evidence_submitted":"CHARGEBACK","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","message":null,"occurred_at":"2025-06-25T18:46:18.03Z","reason":"FRAUD","respond_by":"2025-07-02T18:46:18.51Z","response_state":"RESPONDED","state":"LOST","tags":{"test":"Sale","order_number":"41BFASJSAKAS"},"transfer":"TRntECsQREtT9Ss2nzE4S91F","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRntECsQREtT9Ss2nzE4S91F"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/disputes?limit=3&after_cursor=DIgDv9764vkkEVu1suZNCDbR"}},"page":{"limit":3,"next_cursor":"DIgDv9764vkkEVu1suZNCDbR"}},"key":"List of Disputes","summary":"List of Disputes","id":"paths/~1disputes/get/responses/200/content/application~1json/examples/List of Disputes"},"paths/~1disputes/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1disputes/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Needs Response":{"value":{"id":"DIoGJyoVQ4LBFkfuc8eVkgfL","created_at":"2026-09-30T23:26:45.07Z","updated_at":"2026-09-30T23:26:45.07Z","action":null,"amount":888888,"application":"AP3Jq9GNcnw1BzxHtbcCgcfL","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDjM61nerqKFpCH9gz9p2vXS","merchant":"MU5nUdyGDxrsibubRh3hLyGU","message":null,"occurred_at":"2026-09-30T23:26:44.73Z","reason":"FRAUD","respond_by":"2026-10-07T23:26:45.07Z","response_state":"NEEDS_RESPONSE","state":"PENDING","tags":{},"transfer":"TRdCtihoBec3qj6Pi991wACn","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoGJyoVQ4LBFkfuc8eVkgfL"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP3Jq9GNcnw1BzxHtbcCgcfL"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRdCtihoBec3qj6Pi991wACn"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoGJyoVQ4LBFkfuc8eVkgfL/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoGJyoVQ4LBFkfuc8eVkgfL/adjustment_transfers"}}},"key":"Dispute - Needs Response","summary":"Dispute - Needs Response","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Needs Response"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry":{"value":{"id":"DI36zCEULZSRobTdkVsddn9i","created_at":"2024-10-30T22:39:24.75Z","updated_at":"2025-09-03T22:28:29.97Z","action":null,"amount":2599,"application":"APjzRSvNgT6HYpp3frqnEZFX","dispute_details":{"case_id":"qwerty321","reason_code":"10.1"},"evidence_submitted":"INQUIRY","identity":"ID3kLJLRUWmpUUt3Hy1xGi2z","merchant":"MUqTsyQpykNNiwPG36mUJKWz","message":"The cardholder has a chip card, but the transaction either did not take place at a chip terminal, was not chip read, the chip information sent was incomplete or the transaction was completed with a counterfeit card in a card-present environment.","occurred_at":"2024-10-30T22:38:33.28Z","reason":"FRAUD","respond_by":"2024-11-06T08:00:00.00Z","response_state":"RESPONDED","state":"INQUIRY","tags":{},"transfer":"TRnWtcA4qYWqZ14hkd6G1gst","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DI36zCEULZSRobTdkVsddn9i"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APjzRSvNgT6HYpp3frqnEZFX"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnWtcA4qYWqZ14hkd6G1gst"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DI36zCEULZSRobTdkVsddn9i/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DI36zCEULZSRobTdkVsddn9i/adjustment_transfers"}}},"key":"Dispute - Inquiry","summary":"Dispute - Inquiry","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Chargeback":{"value":{"id":"DI3WpsmRCQdQeZkY2ytzVeMq","created_at":"2026-09-30T16:32:45.11Z","updated_at":"2026-09-30T18:15:16.45Z","action":null,"amount":888888,"application":"AP3Jq9GNcnw1BzxHtbcCgcfL","dispute_details":{"arn":"123"},"evidence_submitted":"CHARGEBACK","identity":"ID22bz4UdHs2GEhs7TNaz5AM","merchant":"MU9F1xm8iqPQkSRqC9mBtEw5","message":null,"occurred_at":"2026-09-30T16:32:44.74Z","reason":"FRAUD","respond_by":"2026-10-07T16:32:45.10Z","response_state":"RESPONDED","state":"PENDING","tags":{},"transfer":"TRiQNvzPQsipKBqHrxZzyZa7","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DI3WpsmRCQdQeZkY2ytzVeMq"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP3Jq9GNcnw1BzxHtbcCgcfL"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRiQNvzPQsipKBqHrxZzyZa7"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DI3WpsmRCQdQeZkY2ytzVeMq/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DI3WpsmRCQdQeZkY2ytzVeMq/adjustment_transfers"}}},"key":"Dispute - Chargeback","summary":"Dispute - Chargeback","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Chargeback"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted":{"value":{"id":"DId6CWsFDuwbuH1xtcccJjmM","created_at":"2026-02-26T18:38:51.10Z","updated_at":"2026-02-26T20:22:22.62Z","action":null,"amount":888888,"application":"APnbAM5AUfqVWogdNAK1uBo","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"ID6FYTFyR4Bvcz8Nf5kxZjDB","merchant":"MUpKQQ83zyTHrGvrFcM52tWj","message":null,"occurred_at":"2026-02-26T18:38:50.65Z","reason":"FRAUD","respond_by":"2026-03-05T18:38:51.07Z","response_state":"ACCEPTED","state":"PENDING","tags":{"test":"dispute-simulation-1772131129"},"transfer":"TRdsziSzzCpmsn4856uyPEAh","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APnbAM5AUfqVWogdNAK1uBo"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRdsziSzzCpmsn4856uyPEAh"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM/adjustment_transfers"}}},"key":"Dispute - Accepted","summary":"Dispute - Accepted","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Won":{"value":{"id":"DIdEH9MLYjz92GjqsHoSSHCb","created_at":"2025-05-22T12:19:01.76Z","updated_at":"2025-05-30T16:07:39.77Z","action":null,"amount":888888,"application":"APw2v7j6dmfrJ5RR9zH7ZVm2","dispute_details":{"case_id":"261409222222222","reason_code":"10.4"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDigdzoCj7uA5HN59DhBUqpM","merchant":"MUh8MYvxQo4nKhZxtftawLKC","message":null,"occurred_at":"2025-05-22T12:18:24.01Z","reason":"FRAUD","respond_by":"2025-05-29T12:19:01.74Z","response_state":"NO_RESPONSE_ALLOWED","state":"WON","tags":{"due_amount":"91375.73","pay_amount":"8888.88","doc_number":"5030999000","id":"163016","customer_user_id":"8cpmtumwkvjs","customer_id":"vr97adqjlkqs","slug":"b2loncmx9hqd"},"transfer":"TRt6XFQrioYwDxasnyJ6UuBW","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIdEH9MLYjz92GjqsHoSSHCb"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APw2v7j6dmfrJ5RR9zH7ZVm2"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRt6XFQrioYwDxasnyJ6UuBW"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIdEH9MLYjz92GjqsHoSSHCb/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIdEH9MLYjz92GjqsHoSSHCb/adjustment_transfers"}}},"key":"Dispute - Won","summary":"Dispute - Won","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Won"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Lost":{"value":{"id":"DIsWauZxrKv94iecNdzNMaQy","created_at":"2026-07-08T15:27:02.83Z","updated_at":"2026-07-08T15:27:55.15Z","action":null,"amount":888888,"application":"AP6kLtnk8hGcB3PXcLvGi2eF","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDuujs4SCJGUbWnR9NcE5RS7","merchant":"MUo5WFMD1cmZBTQVWDvy4Ks8","message":null,"occurred_at":"2026-07-08T15:26:38.74Z","reason":"FRAUD","respond_by":"2026-07-15T15:27:02.85Z","response_state":"NO_RESPONSE_ALLOWED","state":"LOST","tags":{"pay-theory-environment":"austin-paytheorylab","pt-number":"ptl_txn_298Zgekof4vf2txbX1fYAb"},"transfer":"TRkct6nTdRciwUdeePbWezCp","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIsWauZxrKv94iecNdzNMaQy"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP6kLtnk8hGcB3PXcLvGi2eF"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkct6nTdRciwUdeePbWezCp"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIsWauZxrKv94iecNdzNMaQy/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIsWauZxrKv94iecNdzNMaQy/adjustment_transfers"}}},"key":"Dispute - Lost","summary":"Dispute - Lost","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Lost"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response":{"value":{"id":"DIiZd73H29hk18Ywsu5C4iNv","created_at":"2025-12-12T05:24:07.39Z","updated_at":"2025-12-12T05:24:07.36Z","action":"Provide proof that merchandise or service was ordered through a Mail/Phone Order or Electronic Commerce Transaction, and it was shipped/delivered (provide proof of delivery), and a “U” or “Y” AVS response was received (address + 5 or 9 zip matched), and merchandise was delivered to this same AVS address or CVV2 code was U and the presences indicator was 1, 2 or 9 and provide personal identification information such as phone number, email address, mailing address, billing address and IP address.","amount":1000,"application":"APwd8GGQknBSJ9XF2phzya1B","dispute_details":{"case_id":"1234","reason_code":"10.4"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDm9feuekii5bQKg4SiZi6SR","merchant":"MUu1qgRKxkPLj922SLb27Rzw","message":"The cardholder claims they did not participate in or authorize the transaction in a card-not-present environment. Either the account was being fraudulently used or an unclear merchant name has led the cardholder to believe the transaction is fraudulent.","occurred_at":"2025-12-12T05:11:03.35Z","reason":"FRAUD","respond_by":"2025-12-26T00:00:00.00Z","response_state":"NEEDS_RESPONSE","state":"INQUIRY","tags":{},"transfer":"TRwdLadyutk1GKmu5msj8Ybm","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIiZd73H29hk18Ywsu5C4iNv"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APwd8GGQknBSJ9XF2phzya1B"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRwdLadyutk1GKmu5msj8Ybm"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIiZd73H29hk18Ywsu5C4iNv/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIiZd73H29hk18Ywsu5C4iNv/adjustment_transfers"}}},"key":"Dispute - Inquiry Needs Response","summary":"Dispute - Inquiry Needs Response","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Lost":{"value":{"id":"DIadTeB7s41GnDSXNFAiky5F","created_at":"2025-03-27T14:16:12.61Z","updated_at":"2026-06-13T00:21:12.86Z","action":null,"amount":888888,"application":"AP5T12yy2oKPeS7bYD3vpfa6","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDd11q85kT5h8UfsHD7PPQxd","merchant":"MU8GtjC3Kgd3fmKrFw74bEFV","message":null,"occurred_at":"2025-03-27T14:16:11.99Z","reason":"FRAUD","respond_by":"2025-04-03T14:16:12.57Z","response_state":"ACCEPTED","state":"LOST","tags":{"test":"Sale"},"transfer":"TR28RwpxWRzyroeHeNShyDQm","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIadTeB7s41GnDSXNFAiky5F"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP5T12yy2oKPeS7bYD3vpfa6"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR28RwpxWRzyroeHeNShyDQm"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIadTeB7s41GnDSXNFAiky5F/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIadTeB7s41GnDSXNFAiky5F/adjustment_transfers"}}},"key":"Dispute - Accepted Lost","summary":"Dispute - Accepted Lost","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Lost"},"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Won":{"value":{"id":"DIoeusCw6PNG93ajcv5weWVo","created_at":"2026-05-12T10:49:08.55Z","updated_at":"2026-05-12T14:13:48.62Z","action":null,"amount":888888,"application":"AP7kaqPcDsvdCCXXCzRjdDtF","dispute_details":{"case_id":"TEST","reason_code":"10.4"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDrFXqH5gSY88Ryv8LdYwNiS","merchant":"MU7mofbJbH5fSVbcf1A6jh2h","message":null,"occurred_at":"2026-05-12T10:49:08.10Z","reason":"FRAUD","respond_by":"2026-05-19T10:49:08.49Z","response_state":"ACCEPTED","state":"WON","tags":{"fee":"25808","base_amount":"888888","tip":"0","invoice":"6514","tenant":"3367"},"transfer":"TR7oJbnayJmG7SsxAdFFu1kL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoeusCw6PNG93ajcv5weWVo"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP7kaqPcDsvdCCXXCzRjdDtF"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR7oJbnayJmG7SsxAdFFu1kL"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoeusCw6PNG93ajcv5weWVo/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoeusCw6PNG93ajcv5weWVo/adjustment_transfers"}}},"key":"Dispute - Accepted Won","summary":"Dispute - Accepted Won","id":"paths/~1disputes~1{dispute_id}/get/responses/200/content/application~1json/examples/Dispute - Accepted Won"},"paths/~1disputes~1{dispute_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DIgDv9764vkkEVu1suZNCDbR was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1disputes~1{dispute_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1disputes~1{dispute_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}/put/requestBody/content/application~1json/examples/Update Dispute":{"value":{"tags":{"order_number":"41BFASJSAKAS"}},"key":"Update Dispute","summary":"Update Dispute","id":"paths/~1disputes~1{dispute_id}/put/requestBody/content/application~1json/examples/Update Dispute"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Needs Response":{"value":{"id":"DIoGJyoVQ4LBFkfuc8eVkgfL","created_at":"2026-09-30T23:26:45.07Z","updated_at":"2026-09-30T23:26:45.07Z","action":null,"amount":888888,"application":"AP3Jq9GNcnw1BzxHtbcCgcfL","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDjM61nerqKFpCH9gz9p2vXS","merchant":"MU5nUdyGDxrsibubRh3hLyGU","message":null,"occurred_at":"2026-09-30T23:26:44.73Z","reason":"FRAUD","respond_by":"2026-10-07T23:26:45.07Z","response_state":"NEEDS_RESPONSE","state":"PENDING","tags":{},"transfer":"TRdCtihoBec3qj6Pi991wACn","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoGJyoVQ4LBFkfuc8eVkgfL"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP3Jq9GNcnw1BzxHtbcCgcfL"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRdCtihoBec3qj6Pi991wACn"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoGJyoVQ4LBFkfuc8eVkgfL/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoGJyoVQ4LBFkfuc8eVkgfL/adjustment_transfers"}}},"key":"Dispute - Needs Response","summary":"Dispute - Needs Response","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Needs Response"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry":{"value":{"id":"DI36zCEULZSRobTdkVsddn9i","created_at":"2024-10-30T22:39:24.75Z","updated_at":"2025-09-03T22:28:29.97Z","action":null,"amount":2599,"application":"APjzRSvNgT6HYpp3frqnEZFX","dispute_details":{"case_id":"qwerty321","reason_code":"10.1"},"evidence_submitted":"INQUIRY","identity":"ID3kLJLRUWmpUUt3Hy1xGi2z","merchant":"MUqTsyQpykNNiwPG36mUJKWz","message":"The cardholder has a chip card, but the transaction either did not take place at a chip terminal, was not chip read, the chip information sent was incomplete or the transaction was completed with a counterfeit card in a card-present environment.","occurred_at":"2024-10-30T22:38:33.28Z","reason":"FRAUD","respond_by":"2024-11-06T08:00:00.00Z","response_state":"RESPONDED","state":"INQUIRY","tags":{},"transfer":"TRnWtcA4qYWqZ14hkd6G1gst","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DI36zCEULZSRobTdkVsddn9i"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APjzRSvNgT6HYpp3frqnEZFX"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnWtcA4qYWqZ14hkd6G1gst"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DI36zCEULZSRobTdkVsddn9i/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DI36zCEULZSRobTdkVsddn9i/adjustment_transfers"}}},"key":"Dispute - Inquiry","summary":"Dispute - Inquiry","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Chargeback":{"value":{"id":"DI3WpsmRCQdQeZkY2ytzVeMq","created_at":"2026-09-30T16:32:45.11Z","updated_at":"2026-09-30T18:15:16.45Z","action":null,"amount":888888,"application":"AP3Jq9GNcnw1BzxHtbcCgcfL","dispute_details":{"arn":"123"},"evidence_submitted":"CHARGEBACK","identity":"ID22bz4UdHs2GEhs7TNaz5AM","merchant":"MU9F1xm8iqPQkSRqC9mBtEw5","message":null,"occurred_at":"2026-09-30T16:32:44.74Z","reason":"FRAUD","respond_by":"2026-10-07T16:32:45.10Z","response_state":"RESPONDED","state":"PENDING","tags":{},"transfer":"TRiQNvzPQsipKBqHrxZzyZa7","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DI3WpsmRCQdQeZkY2ytzVeMq"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP3Jq9GNcnw1BzxHtbcCgcfL"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRiQNvzPQsipKBqHrxZzyZa7"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DI3WpsmRCQdQeZkY2ytzVeMq/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DI3WpsmRCQdQeZkY2ytzVeMq/adjustment_transfers"}}},"key":"Dispute - Chargeback","summary":"Dispute - Chargeback","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Chargeback"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted":{"value":{"id":"DId6CWsFDuwbuH1xtcccJjmM","created_at":"2026-02-26T18:38:51.10Z","updated_at":"2026-02-26T20:22:22.62Z","action":null,"amount":888888,"application":"APnbAM5AUfqVWogdNAK1uBo","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"ID6FYTFyR4Bvcz8Nf5kxZjDB","merchant":"MUpKQQ83zyTHrGvrFcM52tWj","message":null,"occurred_at":"2026-02-26T18:38:50.65Z","reason":"FRAUD","respond_by":"2026-03-05T18:38:51.07Z","response_state":"ACCEPTED","state":"PENDING","tags":{"test":"dispute-simulation-1772131129"},"transfer":"TRdsziSzzCpmsn4856uyPEAh","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APnbAM5AUfqVWogdNAK1uBo"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRdsziSzzCpmsn4856uyPEAh"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM/adjustment_transfers"}}},"key":"Dispute - Accepted","summary":"Dispute - Accepted","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Won":{"value":{"id":"DIdEH9MLYjz92GjqsHoSSHCb","created_at":"2025-05-22T12:19:01.76Z","updated_at":"2025-05-30T16:07:39.77Z","action":null,"amount":888888,"application":"APw2v7j6dmfrJ5RR9zH7ZVm2","dispute_details":{"case_id":"261409222222222","reason_code":"10.4"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDigdzoCj7uA5HN59DhBUqpM","merchant":"MUh8MYvxQo4nKhZxtftawLKC","message":null,"occurred_at":"2025-05-22T12:18:24.01Z","reason":"FRAUD","respond_by":"2025-05-29T12:19:01.74Z","response_state":"NO_RESPONSE_ALLOWED","state":"WON","tags":{"due_amount":"91375.73","pay_amount":"8888.88","doc_number":"5030999000","id":"163016","customer_user_id":"8cpmtumwkvjs","customer_id":"vr97adqjlkqs","slug":"b2loncmx9hqd"},"transfer":"TRt6XFQrioYwDxasnyJ6UuBW","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIdEH9MLYjz92GjqsHoSSHCb"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APw2v7j6dmfrJ5RR9zH7ZVm2"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRt6XFQrioYwDxasnyJ6UuBW"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIdEH9MLYjz92GjqsHoSSHCb/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIdEH9MLYjz92GjqsHoSSHCb/adjustment_transfers"}}},"key":"Dispute - Won","summary":"Dispute - Won","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Won"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Lost":{"value":{"id":"DIsWauZxrKv94iecNdzNMaQy","created_at":"2026-07-08T15:27:02.83Z","updated_at":"2026-07-08T15:27:55.15Z","action":null,"amount":888888,"application":"AP6kLtnk8hGcB3PXcLvGi2eF","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDuujs4SCJGUbWnR9NcE5RS7","merchant":"MUo5WFMD1cmZBTQVWDvy4Ks8","message":null,"occurred_at":"2026-07-08T15:26:38.74Z","reason":"FRAUD","respond_by":"2026-07-15T15:27:02.85Z","response_state":"NO_RESPONSE_ALLOWED","state":"LOST","tags":{"pay-theory-environment":"austin-paytheorylab","pt-number":"ptl_txn_298Zgekof4vf2txbX1fYAb"},"transfer":"TRkct6nTdRciwUdeePbWezCp","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIsWauZxrKv94iecNdzNMaQy"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP6kLtnk8hGcB3PXcLvGi2eF"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkct6nTdRciwUdeePbWezCp"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIsWauZxrKv94iecNdzNMaQy/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIsWauZxrKv94iecNdzNMaQy/adjustment_transfers"}}},"key":"Dispute - Lost","summary":"Dispute - Lost","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Lost"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response":{"value":{"id":"DIiZd73H29hk18Ywsu5C4iNv","created_at":"2025-12-12T05:24:07.39Z","updated_at":"2025-12-12T05:24:07.36Z","action":"Provide proof that merchandise or service was ordered through a Mail/Phone Order or Electronic Commerce Transaction, and it was shipped/delivered (provide proof of delivery), and a “U” or “Y” AVS response was received (address + 5 or 9 zip matched), and merchandise was delivered to this same AVS address or CVV2 code was U and the presences indicator was 1, 2 or 9 and provide personal identification information such as phone number, email address, mailing address, billing address and IP address.","amount":1000,"application":"APwd8GGQknBSJ9XF2phzya1B","dispute_details":{"case_id":"1234","reason_code":"10.4"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDm9feuekii5bQKg4SiZi6SR","merchant":"MUu1qgRKxkPLj922SLb27Rzw","message":"The cardholder claims they did not participate in or authorize the transaction in a card-not-present environment. Either the account was being fraudulently used or an unclear merchant name has led the cardholder to believe the transaction is fraudulent.","occurred_at":"2025-12-12T05:11:03.35Z","reason":"FRAUD","respond_by":"2025-12-26T00:00:00.00Z","response_state":"NEEDS_RESPONSE","state":"INQUIRY","tags":{},"transfer":"TRwdLadyutk1GKmu5msj8Ybm","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIiZd73H29hk18Ywsu5C4iNv"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APwd8GGQknBSJ9XF2phzya1B"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRwdLadyutk1GKmu5msj8Ybm"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIiZd73H29hk18Ywsu5C4iNv/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIiZd73H29hk18Ywsu5C4iNv/adjustment_transfers"}}},"key":"Dispute - Inquiry Needs Response","summary":"Dispute - Inquiry Needs Response","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Inquiry Needs Response"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Lost":{"value":{"id":"DIadTeB7s41GnDSXNFAiky5F","created_at":"2025-03-27T14:16:12.61Z","updated_at":"2026-06-13T00:21:12.86Z","action":null,"amount":888888,"application":"AP5T12yy2oKPeS7bYD3vpfa6","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDd11q85kT5h8UfsHD7PPQxd","merchant":"MU8GtjC3Kgd3fmKrFw74bEFV","message":null,"occurred_at":"2025-03-27T14:16:11.99Z","reason":"FRAUD","respond_by":"2025-04-03T14:16:12.57Z","response_state":"ACCEPTED","state":"LOST","tags":{"test":"Sale"},"transfer":"TR28RwpxWRzyroeHeNShyDQm","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIadTeB7s41GnDSXNFAiky5F"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP5T12yy2oKPeS7bYD3vpfa6"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR28RwpxWRzyroeHeNShyDQm"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIadTeB7s41GnDSXNFAiky5F/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIadTeB7s41GnDSXNFAiky5F/adjustment_transfers"}}},"key":"Dispute - Accepted Lost","summary":"Dispute - Accepted Lost","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Lost"},"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Won":{"value":{"id":"DIoeusCw6PNG93ajcv5weWVo","created_at":"2026-05-12T10:49:08.55Z","updated_at":"2026-05-12T14:13:48.62Z","action":null,"amount":888888,"application":"AP7kaqPcDsvdCCXXCzRjdDtF","dispute_details":{"case_id":"TEST","reason_code":"10.4"},"evidence_submitted":"NOT_SUPPORTED","identity":"IDrFXqH5gSY88Ryv8LdYwNiS","merchant":"MU7mofbJbH5fSVbcf1A6jh2h","message":null,"occurred_at":"2026-05-12T10:49:08.10Z","reason":"FRAUD","respond_by":"2026-05-19T10:49:08.49Z","response_state":"ACCEPTED","state":"WON","tags":{"fee":"25808","base_amount":"888888","tip":"0","invoice":"6514","tenant":"3367"},"transfer":"TR7oJbnayJmG7SsxAdFFu1kL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoeusCw6PNG93ajcv5weWVo"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/AP7kaqPcDsvdCCXXCzRjdDtF"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR7oJbnayJmG7SsxAdFFu1kL"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoeusCw6PNG93ajcv5weWVo/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DIoeusCw6PNG93ajcv5weWVo/adjustment_transfers"}}},"key":"Dispute - Accepted Won","summary":"Dispute - Accepted Won","id":"paths/~1disputes~1{dispute_id}/put/responses/200/content/application~1json/examples/Dispute - Accepted Won"},"paths/~1disputes~1{dispute_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1disputes~1{dispute_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1disputes~1{dispute_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}/put/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DIgDv9764vkkEVu1suZNCDbR was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1disputes~1{dispute_id}/put/responses/404/content/application~1json/examples/NotFound"},"paths/~1disputes~1{dispute_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1evidence/post/responses/201/content/application~1json/examples/Dispute Evidence":{"value":{"id":"DFet8gXGsH4kXmDWdLhHoKco","created_at":"2025-06-25T19:01:44.33Z","updated_at":"2026-05-05T01:10:44.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","content_type":"image/jpeg","dispute":"DIgDv9764vkkEVu1suZNCDbR","extension":"jpg","file_name":"finix_file.jpg","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","state":"SUCCEEDED","tags":{"file-extension":".jpg","content-type":"image/jpeg","file-name":"finix_file.jpg","order_number":"41BFASJSAKAS"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}},"key":"Dispute Evidence","summary":"Dispute Evidence","id":"paths/~1disputes~1{dispute_id}~1evidence/post/responses/201/content/application~1json/examples/Dispute Evidence"},"paths/~1disputes~1{dispute_id}~1evidence/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1disputes~1{dispute_id}~1evidence/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1disputes~1{dispute_id}~1evidence/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1evidence/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1evidence/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1evidence/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1evidence/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1evidence/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1evidence/get/responses/200/content/application~1json/examples/List of Dispute Evidence Resources":{"value":{"_embedded":{"evidences":[{"id":"DFdmgELVZSBWFaD23bNtYYrP","created_at":"2025-10-28T01:13:26.95Z","updated_at":"2026-05-05T01:10:44.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","content_type":"image/jpeg","dispute":"DIgDv9764vkkEVu1suZNCDbR","extension":"jpeg","file_name":"Screenshot 2025-10-27 at 4.18.40 PM.jpeg","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","state":"SUCCEEDED","tags":{"file-extension":".jpg","content-type":"image/jpeg","file-name":"Screenshot 2025-10-27 at 4.18.40 PM.jpeg"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFdmgELVZSBWFaD23bNtYYrP"}}},{"id":"DF4JoaNaYWqKw557QuqmF6cC","created_at":"2025-10-28T00:49:05.62Z","updated_at":"2026-05-05T01:10:44.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","content_type":"image/jpeg","dispute":"DIgDv9764vkkEVu1suZNCDbR","extension":"jpeg","file_name":"Screenshot 2025-10-27 at 4.18.40 PM.jpeg","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","state":"SUCCEEDED","tags":{"file-extension":".jpg","content-type":"image/jpeg","file-name":"Screenshot 2025-10-27 at 4.18.40 PM.jpeg"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DF4JoaNaYWqKw557QuqmF6cC"}}},{"id":"DFmYv33etHEsfNiHjz8dV8dJ","created_at":"2025-10-28T00:41:28.15Z","updated_at":"2026-05-05T01:10:44.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","content_type":"image/jpeg","dispute":"DIgDv9764vkkEVu1suZNCDbR","extension":"jpeg","file_name":"Screenshot 2025-10-27 at 4.18.40 PM.jpeg","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","state":"SUCCEEDED","tags":{"file-extension":".jpg","content-type":"image/jpeg","file-name":"Screenshot 2025-10-27 at 4.18.40 PM.jpeg"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFmYv33etHEsfNiHjz8dV8dJ"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence?limit=3&after_cursor=DFmYv33etHEsfNiHjz8dV8dJ"}},"page":{"limit":3,"next_cursor":"DFmYv33etHEsfNiHjz8dV8dJ"}},"key":"List of Dispute Evidence Resources","summary":"List of Dispute Evidence Resources","id":"paths/~1disputes~1{dispute_id}~1evidence/get/responses/200/content/application~1json/examples/List of Dispute Evidence Resources"},"paths/~1disputes~1{dispute_id}~1evidence/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1evidence/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1evidence/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1evidence/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1evidence/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DIgDv9764vkkEVu1suZNCDbR was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1disputes~1{dispute_id}~1evidence/get/responses/404/content/application~1json/examples/Not found"},"paths/~1disputes~1{dispute_id}~1evidence/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1evidence/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1evidence/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1disputes~1{dispute_id}~1evidence/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/200/content/application~1json/examples/Dispute Evidence":{"value":{"id":"DFet8gXGsH4kXmDWdLhHoKco","created_at":"2025-06-25T19:01:44.33Z","updated_at":"2026-05-05T01:10:44.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","content_type":"image/jpeg","dispute":"DIgDv9764vkkEVu1suZNCDbR","extension":"jpg","file_name":"finix_file.jpg","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","state":"SUCCEEDED","tags":{"file-extension":".jpg","content-type":"image/jpeg","file-name":"finix_file.jpg","order_number":"41BFASJSAKAS"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}},"key":"Dispute Evidence","summary":"Dispute Evidence","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/200/content/application~1json/examples/Dispute Evidence"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DFet8gXGsH4kXmDWdLhHoKco was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/requestBody/content/application~1json/examples/Update Dispute":{"value":{"tags":{"content-type":"image/jpeg","file-extension":".jpg","file-name":"evidence.jpg"}},"key":"Update Dispute","summary":"Update Dispute","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/requestBody/content/application~1json/examples/Update Dispute"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/200/content/application~1json/examples/Dispute Evidence":{"value":{"id":"DFet8gXGsH4kXmDWdLhHoKco","created_at":"2025-06-25T19:01:44.33Z","updated_at":"2026-05-05T01:10:44.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","content_type":"image/jpeg","dispute":"DIgDv9764vkkEVu1suZNCDbR","extension":"jpg","file_name":"finix_file.jpg","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","state":"SUCCEEDED","tags":{"file-extension":".jpg","content-type":"image/jpeg","file-name":"finix_file.jpg","order_number":"41BFASJSAKAS"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}},"key":"Dispute Evidence","summary":"Dispute Evidence","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/200/content/application~1json/examples/Dispute Evidence"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DFet8gXGsH4kXmDWdLhHoKco was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/404/content/application~1json/examples/NotFound"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DFet8gXGsH4kXmDWdLhHoKco was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/404/content/application~1json/examples/NotFound"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/422/content/application~1json/examples/Merchant not on FINIX_V1 or DUMMY_V1":{"value":{"total":1,"_embedded":{"errors":[{"logref":"eaf8fef34dc3a825","message":"Deletion of dispute evidence files is not allowed for {PROCESSOR_TYPE}.","code":"UNPROCESSABLE_ENTITY","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}}]}},"key":"Merchant not on FINIX_V1 or DUMMY_V1","summary":"Merchant not on FINIX_V1 or DUMMY_V1","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}/delete/responses/422/content/application~1json/examples/Merchant not on FINIX_V1 or DUMMY_V1"},"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/200/content/application~1json/examples/List of Adjustment Transfers in a Dispute:":{"value":{"_embedded":{"transfers":[{"id":"TRvF9YnyivebZ4tFMBPj3fWY","created_at":"2025-06-25T18:46:18.52Z","updated_at":"2025-06-25T18:46:18.52Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":888888,"amount_requested":888888,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":"PI6iQcTtJNCS8GZAVKYi5Ueb","externally_funded":"FALSE","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":null,"operation_key":null,"parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":"2025-06-25T18:46:18.72Z","receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"SUCCEEDED","statement_descriptor":null,"subtype":"MERCHANT_DEBIT","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"f2cbe085-129f-46b7-b9d7-90f6708c9c13","type":"DISPUTE","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRvF9YnyivebZ4tFMBPj3fWY"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRvF9YnyivebZ4tFMBPj3fWY/payment_instruments"},"disputed_transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRvF9YnyivebZ4tFMBPj3fWY/disputed_transfer"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},{"id":"TRpxCZRBtMbcGYbtvCxVYSpe","created_at":"2025-06-25T18:46:18.52Z","updated_at":"2025-06-25T18:46:18.52Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":888888,"amount_requested":888888,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"FALSE","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":null,"operation_key":null,"parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":"2025-06-25T18:46:18.79Z","receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"SUCCEEDED","statement_descriptor":null,"subtype":"PLATFORM_CREDIT","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"7d7ff19a-0b53-4492-9374-a06e8c582e30","type":"DISPUTE","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRpxCZRBtMbcGYbtvCxVYSpe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRpxCZRBtMbcGYbtvCxVYSpe/payment_instruments"},"disputed_transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRpxCZRBtMbcGYbtvCxVYSpe/disputed_transfer"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers?limit=3&after_cursor=TRpxCZRBtMbcGYbtvCxVYSpe"}},"page":{"limit":3,"next_cursor":"TRpxCZRBtMbcGYbtvCxVYSpe"}},"key":"List of Adjustment Transfers in a Dispute:","summary":"List of Adjustment Transfers in a Dispute:","id":"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/200/content/application~1json/examples/List of Adjustment Transfers in a Dispute:"},"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DIgDv9764vkkEVu1suZNCDbR was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/404/content/application~1json/examples/Not found"},"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/adjustment_transfers"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1disputes~1{dispute_id}~1adjustment_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1disputes~1{dispute_id}~1submit/post/requestBody/content/application~1json/examples/Submit Dispute Evidence":{"value":{"note":"Partial rebuttal is due to double charging cardholder due to technical malfunction on point of sale, but we have attached receipt as proof that cardhoder received item."},"key":"Submit Dispute Evidence","summary":"Submit Dispute Evidence","id":"paths/~1disputes~1{dispute_id}~1submit/post/requestBody/content/application~1json/examples/Submit Dispute Evidence"},"paths/~1disputes~1{dispute_id}~1submit/post/responses/202/content/application~1json/examples/Dispute Evidence":{"value":{"id":"DFet8gXGsH4kXmDWdLhHoKco","created_at":"2025-06-25T19:01:44.33Z","updated_at":"2026-05-05T01:10:44.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","content_type":"image/jpeg","dispute":"DIgDv9764vkkEVu1suZNCDbR","extension":"jpg","file_name":"finix_file.jpg","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","state":"SUCCEEDED","tags":{"file-extension":".jpg","content-type":"image/jpeg","file-name":"finix_file.jpg","order_number":"41BFASJSAKAS"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco"}}},"key":"Dispute Evidence","summary":"Dispute Evidence","id":"paths/~1disputes~1{dispute_id}~1submit/post/responses/202/content/application~1json/examples/Dispute Evidence"},"paths/~1disputes~1{dispute_id}~1submit/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/submit"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1disputes~1{dispute_id}~1submit/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1disputes~1{dispute_id}~1submit/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/submit"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1submit/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1submit/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/submit"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1submit/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1submit/post/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DIgDv9764vkkEVu1suZNCDbR was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/submit"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1disputes~1{dispute_id}~1submit/post/responses/404/content/application~1json/examples/NotFound"},"paths/~1disputes~1{dispute_id}~1submit/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/submit"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1submit/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1accept/post/requestBody/content/application~1json/examples/Accept Dispute":{"value":{"note":"Accepting Dispute: Valid Reason"},"key":"Accept Dispute","summary":"Accept Dispute","id":"paths/~1disputes~1{dispute_id}~1accept/post/requestBody/content/application~1json/examples/Accept Dispute"},"paths/~1disputes~1{dispute_id}~1accept/post/responses/202/content/application~1json/examples/Dispute - Accepted":{"value":{"id":"DId6CWsFDuwbuH1xtcccJjmM","created_at":"2026-02-26T18:38:51.10Z","updated_at":"2026-02-26T20:22:22.62Z","action":null,"amount":888888,"application":"APnbAM5AUfqVWogdNAK1uBo","dispute_details":{"arn":"123"},"evidence_submitted":"NOT_SUPPORTED","identity":"ID6FYTFyR4Bvcz8Nf5kxZjDB","merchant":"MUpKQQ83zyTHrGvrFcM52tWj","message":null,"occurred_at":"2026-02-26T18:38:50.65Z","reason":"FRAUD","respond_by":"2026-03-05T18:38:51.07Z","response_state":"ACCEPTED","state":"PENDING","tags":{"test":"dispute-simulation-1772131129"},"transfer":"TRdsziSzzCpmsn4856uyPEAh","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APnbAM5AUfqVWogdNAK1uBo"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRdsziSzzCpmsn4856uyPEAh"},"evidence":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM/evidence"},"adjustment_transfers":{"href":"https://finix.sandbox-payments-api.com/disputes/DId6CWsFDuwbuH1xtcccJjmM/adjustment_transfers"}}},"key":"Dispute - Accepted","summary":"Dispute - Accepted","id":"paths/~1disputes~1{dispute_id}~1accept/post/responses/202/content/application~1json/examples/Dispute - Accepted"},"paths/~1disputes~1{dispute_id}~1accept/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/accept"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1disputes~1{dispute_id}~1accept/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1disputes~1{dispute_id}~1accept/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/accept"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1accept/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1accept/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/accept"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1accept/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1accept/post/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DIgDv9764vkkEVu1suZNCDbR was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/accept"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1disputes~1{dispute_id}~1accept/post/responses/404/content/application~1json/examples/Not found"},"paths/~1disputes~1{dispute_id}~1accept/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/accept"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1accept/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disputes~1{dispute_id}~1accept/post/responses/422/content/application~1json/examples/Cannot accept after evidence submitted":{"value":{"total":1,"_embedded":{"errors":[{"logref":"9fec14b06197d077","message":"Accepting a dispute after evidence has already been submitted is not\ncurrently supported. Please contact support if you need to accept this\ndispute.\n","code":"UNPROCESSABLE_ENTITY","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/accept"}}}]}},"key":"Cannot accept after evidence submitted","summary":"Cannot accept after evidence submitted","id":"paths/~1disputes~1{dispute_id}~1accept/post/responses/422/content/application~1json/examples/Cannot accept after evidence submitted"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/200/content/application~1octet-stream/examples/Download Begins":{"value":{},"key":"Download Begins","summary":"Download Begins","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/200/content/application~1octet-stream/examples/Download Begins"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco/download"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco/download"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"DFet8gXGsH4kXmDWdLhHoKco was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco/download"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disputes/DIgDv9764vkkEVu1suZNCDbR/evidence/DFet8gXGsH4kXmDWdLhHoKco/download"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disputes~1{dispute_id}~1evidence~1{evidence_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees":{"value":{"_embedded":{"fees":[{"id":"FE3ftd3ccdG1cepfPyZdBPbS","created_at":"2026-09-25T20:38:31.51Z","updated_at":"2026-09-25T20:38:31.51Z","amount":30,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":null,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","fee_subtype":"PLATFORM_FEE","fee_type":"CARD_FIXED","label":null,"linked_id":"TR3dn2nMmoSc4h8m43aqAdvx","linked_to":"TR3dn2nMmoSc4h8m43aqAdvx","linked_type":"TRANSFER","merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","ready_to_settle_at":"2026-09-26T20:38:31.09Z","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FE3ftd3ccdG1cepfPyZdBPbS"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUcgYZswyRfqSSbvMsxuaHxZ"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR3dn2nMmoSc4h8m43aqAdvx"}}},{"id":"FE3fqDQs8TegGqg98GPXRDYf","created_at":"2026-09-25T20:38:31.51Z","updated_at":"2026-09-25T20:38:31.51Z","amount":577.1,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":null,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","fee_subtype":"PLATFORM_FEE","fee_type":"CARD_BASIS_POINTS","label":null,"linked_id":"TR3dn2nMmoSc4h8m43aqAdvx","linked_to":"TR3dn2nMmoSc4h8m43aqAdvx","linked_type":"TRANSFER","merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","ready_to_settle_at":"2026-09-26T20:38:31.09Z","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FE3fqDQs8TegGqg98GPXRDYf"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUcgYZswyRfqSSbvMsxuaHxZ"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR3dn2nMmoSc4h8m43aqAdvx"}}},{"id":"FE3ckrv4GWMggj3s3h5vBo5s","created_at":"2026-09-25T20:38:30.74Z","updated_at":"2026-09-25T20:38:30.74Z","amount":30,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":null,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","fee_subtype":"PLATFORM_FEE","fee_type":"CARD_FIXED","label":null,"linked_id":"TR3akYq8p48fsJYCSnbUD8Bp","linked_to":"TR3akYq8p48fsJYCSnbUD8Bp","linked_type":"TRANSFER","merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","ready_to_settle_at":"2026-09-26T20:38:30.38Z","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FE3ckrv4GWMggj3s3h5vBo5s"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUcgYZswyRfqSSbvMsxuaHxZ"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR3akYq8p48fsJYCSnbUD8Bp"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/fees?limit=3&after_cursor=FE3ckrv4GWMggj3s3h5vBo5s"}},"page":{"limit":3,"next_cursor":"FE3ckrv4GWMggj3s3h5vBo5s"}},"key":"List of Fees","summary":"List of Fees","id":"paths/~1fees/get/responses/200/content/application~1json/examples/List of Fees"},"paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1fees/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1fees/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1fees/post/requestBody/content/application~1json/examples/Fee":{"value":{"amount":10000,"currency":"USD","display_name":"April_Monthly_Fee","fee_subtype":"CUSTOM","fee_type":"CUSTOM","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","tags":{"order_id":"ORD-123"}},"key":"Fee","summary":"Fee","id":"paths/~1fees/post/requestBody/content/application~1json/examples/Fee"},"paths/~1fees/post/responses/201/content/application~1json/examples/Fee":{"value":{"id":"FEdSsGnJgLR4L178ZrMR3JWA","created_at":"2026-09-25T20:05:08.39Z","updated_at":"2026-09-25T20:05:08.39Z","amount":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":"April_Monthly_Fee","fee_profile":null,"fee_subtype":"CUSTOM","fee_type":"CUSTOM","label":"April_Monthly_Fee","linked_id":null,"linked_to":null,"linked_type":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","ready_to_settle_at":"2026-09-25T20:05:08.39Z","tags":{"order_id":"ORD-123"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEdSsGnJgLR4L178ZrMR3JWA"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm"}}},"key":"Fee","summary":"Fee","id":"paths/~1fees/post/responses/201/content/application~1json/examples/Fee"},"paths/~1fees/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1fees/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1fees/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1fees/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1fees/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1fees/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1fees/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1fees/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1fees~1{fee_id}/get/responses/200/content/application~1json/examples/Fee":{"value":{"id":"FEvjF5iPwy6zuUEsBWgJ9T79","created_at":"2024-12-16T08:33:42.12Z","updated_at":"2025-06-17T22:27:22.96Z","amount":151,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":null,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","fee_subtype":"PLATFORM_FEE","fee_type":"CARD_BASIS_POINTS","label":null,"linked_id":"TRfnif8f9U1r6k2zys27U4yP","linked_to":"TRfnif8f9U1r6k2zys27U4yP","linked_type":"TRANSFER","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","ready_to_settle_at":"2024-12-17T08:33:42.14Z","tags":{"test":"test"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TRfnif8f9U1r6k2zys27U4yP"}}},"key":"Fee","summary":"Fee","id":"paths/~1fees~1{fee_id}/get/responses/200/content/application~1json/examples/Fee"},"paths/~1fees~1{fee_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1fees~1{fee_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1fees~1{fee_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1fees~1{fee_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1fees~1{fee_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"FEvjF5iPwy6zuUEsBWgJ9T79 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1fees~1{fee_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1fees~1{fee_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1fees~1{fee_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1fees~1{fee_id}/put/requestBody/content/application~1json/examples/Update Fee":{"value":{"tags":{"test":"test"}},"key":"Update Fee","summary":"Update Fee","id":"paths/~1fees~1{fee_id}/put/requestBody/content/application~1json/examples/Update Fee"},"paths/~1fees~1{fee_id}/put/responses/200/content/application~1json/examples/Fee":{"value":{"id":"FEnzgwGtLzFk61rDdUqsHFAj","created_at":"2026-05-26T21:13:03.22Z","updated_at":"2026-09-25T20:05:08.66Z","amount":30,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":null,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","fee_subtype":"PLATFORM_FEE","fee_type":"CARD_FIXED","label":null,"linked_id":"split_transfer_jyjSy2p9RDTk5b4DE7Kztw","linked_to":"split_transfer_jyjSy2p9RDTk5b4DE7Kztw","linked_type":"SPLIT_TRANSFER","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","ready_to_settle_at":"2026-05-27T21:12:22.37Z","tags":{"test":"test"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEnzgwGtLzFk61rDdUqsHFAj"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm"}}},"key":"Fee","summary":"Fee","id":"paths/~1fees~1{fee_id}/put/responses/200/content/application~1json/examples/Fee"},"paths/~1fees~1{fee_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1fees~1{fee_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1fees~1{fee_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1fees~1{fee_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1fees~1{fee_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1fees~1{fee_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1fees~1{fee_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"FEvjF5iPwy6zuUEsBWgJ9T79 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1fees~1{fee_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1fees~1{fee_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FEvjF5iPwy6zuUEsBWgJ9T79"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1fees~1{fee_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Blended Profile":{"value":{"ach_basis_points":290,"ach_credit_return_fixed_fee":500,"ach_debit_return_fixed_fee":500,"ach_fixed_fee":50,"basis_points":290,"card_cross_border_basis_points":150,"dispute_fixed_fee":3000,"fixed_fee":30},"key":"Blended Profile","summary":"Blended Profile","id":"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Blended Profile"},"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus Profile":{"value":{"ach_basis_points":20,"ach_credit_return_fixed_fee":500,"ach_debit_return_fixed_fee":500,"ach_fixed_fee":50,"basis_points":20,"charge_interchange":true,"dispute_fixed_fee":3000,"fixed_fee":10},"key":"Interchange Plus Profile","summary":"Interchange Plus Profile","id":"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus Profile"},"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus and Dues and Assessments":{"value":{"ach_basis_points":20,"ach_credit_return_fixed_fee":500,"ach_debit_return_fixed_fee":500,"ach_fixed_fee":50,"basis_points":20,"charge_dues_assessments":true,"charge_interchange":true,"dispute_fixed_fee":3000,"fixed_fee":10},"key":"Interchange Plus and Dues and Assessments","summary":"Interchange Plus and Dues and Assessments","id":"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/Interchange Plus and Dues and Assessments"},"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/All Fields":{"value":{"ach_basis_points":30,"ach_basis_points_fee_limit":50,"ach_credit_return_fixed_fee":25,"ach_debit_return_fixed_fee":30,"ach_fixed_fee":40,"ach_notice_of_change_credit_fixed_fee":12,"ach_notice_of_change_debit_fixed_fee":25,"american_express_basis_points":10,"american_express_charge_interchange":true,"american_express_fixed_fee":15,"ancillary_fixed_fee_primary":32,"ancillary_fixed_fee_secondary":80,"basis_points":20,"card_cross_border_basis_points":15,"card_cross_border_fixed_fee":30,"charge_all_authorization_requests":true,"charge_all_reversal_requests":true,"charge_all_transfer_requests":true,"charge_dues_assessments":true,"charge_interchange":false,"compliance_forms_overdue_fixed_fee":20,"diners_club_basis_points":90,"diners_club_charge_interchange":true,"diners_club_fixed_fee":25,"discover_basis_points":12,"discover_charge_interchange":true,"discover_fixed_fee":35,"dispute_fixed_fee":1500,"dispute_inquiry_fixed_fee":1500,"eft_basis_points":25,"eft_basis_points_fee_limit":20,"eft_credit_return_fixed_fee":35,"eft_debit_return_fixed_fee":30,"eft_fixed_fee":15,"externally_funded_basis_points":15,"externally_funded_fixed_fee":20,"fixed_fee":20,"interac_basis_points":20,"interac_fixed_fee":25,"jcb_basis_points":11,"jcb_charge_interchange":true,"jcb_fixed_fee":20,"mastercard_basis_points":30,"mastercard_charge_interchange":true,"mastercard_fixed_fee":18,"visa_basis_points":10,"visa_charge_interchange":true,"visa_fixed_fee":20},"key":"All Fields","summary":"All Fields","id":"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/All Fields"},"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/No Fees":{"value":{"ach_basis_points":0,"ach_credit_return_fixed_fee":0,"ach_debit_return_fixed_fee":0,"ach_fixed_fee":0,"basis_points":0,"dispute_fixed_fee":0,"fixed_fee":0},"key":"No Fees","summary":"No Fees","id":"paths/~1fee_profiles/post/requestBody/content/application~1json/examples/No Fees"},"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Blended Profile":{"value":{"id":"FPqgj43XsLCEyrqLqFgTXndh","created_at":"2026-09-25T20:05:07.15Z","updated_at":"2026-09-25T20:05:07.15Z","ach_basis_points":290,"ach_basis_points_fee_limit":null,"ach_credit_return_fixed_fee":500,"ach_debit_return_fixed_fee":500,"ach_fixed_fee":50,"ach_notice_of_change_credit_fixed_fee":null,"ach_notice_of_change_debit_fixed_fee":null,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":null,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":null,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":null,"ancillary_fixed_fee_primary":null,"ancillary_fixed_fee_secondary":null,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":290,"card_account_updater_fixed_fee":null,"card_cross_border_basis_points":150,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":null,"charge_all_reversal_requests":null,"charge_all_transfer_requests":null,"charge_dues_assessments":null,"charge_interchange":false,"compliance_forms_overdue_fixed_fee":null,"diners_club_basis_points":null,"diners_club_charge_interchange":null,"diners_club_fixed_fee":null,"discover_assessments_basis_points":null,"discover_basis_points":null,"discover_charge_dues_assessments":null,"discover_charge_interchange":null,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":null,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":3000,"dispute_inquiry_fixed_fee":null,"eft_basis_points":null,"eft_basis_points_fee_limit":null,"eft_credit_return_fixed_fee":null,"eft_debit_return_fixed_fee":null,"eft_fixed_fee":null,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":null,"externally_funded_fixed_fee":null,"fixed_fee":30,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":null,"interac_fixed_fee":null,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":null,"jcb_charge_interchange":null,"jcb_fixed_fee":null,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":null,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":null,"mastercard_fixed_fee":null,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":null,"visa_charge_dues_assessments":null,"visa_charge_interchange":null,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":null,"visa_kilobyte_access_fixed_fee":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPqgj43XsLCEyrqLqFgTXndh"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Blended Profile","summary":"Blended Profile","id":"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Blended Profile"},"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus Profile":{"value":{"id":"FPuzPuREXN9GnN13VQn87dC8","created_at":"2026-09-25T20:05:07.46Z","updated_at":"2026-09-25T20:05:07.46Z","ach_basis_points":20,"ach_basis_points_fee_limit":null,"ach_credit_return_fixed_fee":500,"ach_debit_return_fixed_fee":500,"ach_fixed_fee":50,"ach_notice_of_change_credit_fixed_fee":null,"ach_notice_of_change_debit_fixed_fee":null,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":null,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":null,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":null,"ancillary_fixed_fee_primary":null,"ancillary_fixed_fee_secondary":null,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":20,"card_account_updater_fixed_fee":null,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":null,"charge_all_reversal_requests":null,"charge_all_transfer_requests":null,"charge_dues_assessments":null,"charge_interchange":true,"compliance_forms_overdue_fixed_fee":null,"diners_club_basis_points":null,"diners_club_charge_interchange":null,"diners_club_fixed_fee":null,"discover_assessments_basis_points":null,"discover_basis_points":null,"discover_charge_dues_assessments":null,"discover_charge_interchange":null,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":null,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":3000,"dispute_inquiry_fixed_fee":null,"eft_basis_points":null,"eft_basis_points_fee_limit":null,"eft_credit_return_fixed_fee":null,"eft_debit_return_fixed_fee":null,"eft_fixed_fee":null,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":null,"externally_funded_fixed_fee":null,"fixed_fee":10,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":null,"interac_fixed_fee":null,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":null,"jcb_charge_interchange":null,"jcb_fixed_fee":null,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":null,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":null,"mastercard_fixed_fee":null,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":null,"visa_charge_dues_assessments":null,"visa_charge_interchange":null,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":null,"visa_kilobyte_access_fixed_fee":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuzPuREXN9GnN13VQn87dC8"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Interchange Plus Profile","summary":"Interchange Plus Profile","id":"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus Profile"},"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus and Dues and Assessments":{"value":{"id":"FPfjUi5vg3omQMKtS6QC3VDx","created_at":"2026-09-25T20:05:07.76Z","updated_at":"2026-09-25T20:05:07.76Z","ach_basis_points":20,"ach_basis_points_fee_limit":null,"ach_credit_return_fixed_fee":500,"ach_debit_return_fixed_fee":500,"ach_fixed_fee":50,"ach_notice_of_change_credit_fixed_fee":null,"ach_notice_of_change_debit_fixed_fee":null,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":null,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":null,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":null,"ancillary_fixed_fee_primary":null,"ancillary_fixed_fee_secondary":null,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":20,"card_account_updater_fixed_fee":null,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":null,"charge_all_reversal_requests":null,"charge_all_transfer_requests":null,"charge_dues_assessments":true,"charge_interchange":true,"compliance_forms_overdue_fixed_fee":null,"diners_club_basis_points":null,"diners_club_charge_interchange":null,"diners_club_fixed_fee":null,"discover_assessments_basis_points":null,"discover_basis_points":null,"discover_charge_dues_assessments":null,"discover_charge_interchange":null,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":null,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":3000,"dispute_inquiry_fixed_fee":null,"eft_basis_points":null,"eft_basis_points_fee_limit":null,"eft_credit_return_fixed_fee":null,"eft_debit_return_fixed_fee":null,"eft_fixed_fee":null,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":null,"externally_funded_fixed_fee":null,"fixed_fee":10,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":null,"interac_fixed_fee":null,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":null,"jcb_charge_interchange":null,"jcb_fixed_fee":null,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":null,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":null,"mastercard_fixed_fee":null,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":null,"visa_charge_dues_assessments":null,"visa_charge_interchange":null,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":null,"visa_kilobyte_access_fixed_fee":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPfjUi5vg3omQMKtS6QC3VDx"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Interchange Plus and Dues and Assessments","summary":"Interchange Plus and Dues and Assessments","id":"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/Interchange Plus and Dues and Assessments"},"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/All Fields":{"value":{"id":"FPmH8SgwcrgpV595sojbKXNB","created_at":"2026-09-25T20:05:06.83Z","updated_at":"2026-09-25T20:05:06.83Z","ach_basis_points":30,"ach_basis_points_fee_limit":50,"ach_credit_return_fixed_fee":25,"ach_debit_return_fixed_fee":30,"ach_fixed_fee":40,"ach_notice_of_change_credit_fixed_fee":12,"ach_notice_of_change_debit_fixed_fee":25,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":10,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":true,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":15,"ancillary_fixed_fee_primary":32,"ancillary_fixed_fee_secondary":80,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":20,"card_account_updater_fixed_fee":null,"card_cross_border_basis_points":15,"card_cross_border_fixed_fee":30,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":true,"charge_all_reversal_requests":true,"charge_all_transfer_requests":true,"charge_dues_assessments":true,"charge_interchange":false,"compliance_forms_overdue_fixed_fee":20,"diners_club_basis_points":90,"diners_club_charge_interchange":true,"diners_club_fixed_fee":25,"discover_assessments_basis_points":null,"discover_basis_points":12,"discover_charge_dues_assessments":null,"discover_charge_interchange":true,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":35,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":1500,"dispute_inquiry_fixed_fee":1500,"eft_basis_points":25,"eft_basis_points_fee_limit":20,"eft_credit_return_fixed_fee":35,"eft_debit_return_fixed_fee":30,"eft_fixed_fee":15,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":15,"externally_funded_fixed_fee":20,"fixed_fee":20,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":20,"interac_fixed_fee":25,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":11,"jcb_charge_interchange":true,"jcb_fixed_fee":20,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":30,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":true,"mastercard_fixed_fee":18,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":10,"visa_charge_dues_assessments":null,"visa_charge_interchange":true,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":20,"visa_kilobyte_access_fixed_fee":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmH8SgwcrgpV595sojbKXNB"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"All Fields","summary":"All Fields","id":"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/All Fields"},"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/No Fees":{"value":{"id":"FPf2jgV9o2ZiVBRWvv45bPL2","created_at":"2026-09-25T20:05:08.09Z","updated_at":"2026-09-25T20:05:08.09Z","ach_basis_points":0,"ach_basis_points_fee_limit":null,"ach_credit_return_fixed_fee":0,"ach_debit_return_fixed_fee":0,"ach_fixed_fee":0,"ach_notice_of_change_credit_fixed_fee":null,"ach_notice_of_change_debit_fixed_fee":null,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":null,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":null,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":null,"ancillary_fixed_fee_primary":null,"ancillary_fixed_fee_secondary":null,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":0,"card_account_updater_fixed_fee":null,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":null,"charge_all_reversal_requests":null,"charge_all_transfer_requests":null,"charge_dues_assessments":null,"charge_interchange":false,"compliance_forms_overdue_fixed_fee":null,"diners_club_basis_points":null,"diners_club_charge_interchange":null,"diners_club_fixed_fee":null,"discover_assessments_basis_points":null,"discover_basis_points":null,"discover_charge_dues_assessments":null,"discover_charge_interchange":null,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":null,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":0,"dispute_inquiry_fixed_fee":null,"eft_basis_points":null,"eft_basis_points_fee_limit":null,"eft_credit_return_fixed_fee":null,"eft_debit_return_fixed_fee":null,"eft_fixed_fee":null,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":null,"externally_funded_fixed_fee":null,"fixed_fee":0,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":null,"interac_fixed_fee":null,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":null,"jcb_charge_interchange":null,"jcb_fixed_fee":null,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":null,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":null,"mastercard_fixed_fee":null,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":null,"visa_charge_dues_assessments":null,"visa_charge_interchange":null,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":null,"visa_kilobyte_access_fixed_fee":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPf2jgV9o2ZiVBRWvv45bPL2"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"No Fees","summary":"No Fees","id":"paths/~1fee_profiles/post/responses/201/content/application~1json/examples/No Fees"},"paths/~1fee_profiles/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1fee_profiles/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1fee_profiles/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1fee_profiles/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1fee_profiles/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1fee_profiles/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1fee_profiles/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1fee_profiles/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1fee_profiles/get/responses/200/content/application~1json/examples/List of Fee Profiles":{"value":{"_embedded":{"fee_profiles":[{"id":"FPf2jgV9o2ZiVBRWvv45bPL2","created_at":"2026-09-25T20:05:08.09Z","updated_at":"2026-09-25T20:05:08.09Z","ach_basis_points":0,"ach_basis_points_fee_limit":null,"ach_credit_return_fixed_fee":0,"ach_debit_return_fixed_fee":0,"ach_fixed_fee":0,"ach_notice_of_change_credit_fixed_fee":null,"ach_notice_of_change_debit_fixed_fee":null,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":null,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":null,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":null,"ancillary_fixed_fee_primary":null,"ancillary_fixed_fee_secondary":null,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":0,"card_account_updater_fixed_fee":null,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":null,"charge_all_reversal_requests":null,"charge_all_transfer_requests":null,"charge_dues_assessments":null,"charge_interchange":false,"compliance_forms_overdue_fixed_fee":null,"diners_club_basis_points":null,"diners_club_charge_interchange":null,"diners_club_fixed_fee":null,"discover_assessments_basis_points":null,"discover_basis_points":null,"discover_charge_dues_assessments":null,"discover_charge_interchange":null,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":null,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":0,"dispute_inquiry_fixed_fee":null,"eft_basis_points":null,"eft_basis_points_fee_limit":null,"eft_credit_return_fixed_fee":null,"eft_debit_return_fixed_fee":null,"eft_fixed_fee":null,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":null,"externally_funded_fixed_fee":null,"fixed_fee":0,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":null,"interac_fixed_fee":null,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":null,"jcb_charge_interchange":null,"jcb_fixed_fee":null,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":null,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":null,"mastercard_fixed_fee":null,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":null,"visa_charge_dues_assessments":null,"visa_charge_interchange":null,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":null,"visa_kilobyte_access_fixed_fee":null,"_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPf2jgV9o2ZiVBRWvv45bPL2"}}},{"id":"FPfjUi5vg3omQMKtS6QC3VDx","created_at":"2026-09-25T20:05:07.76Z","updated_at":"2026-09-25T20:05:07.76Z","ach_basis_points":20,"ach_basis_points_fee_limit":null,"ach_credit_return_fixed_fee":500,"ach_debit_return_fixed_fee":500,"ach_fixed_fee":50,"ach_notice_of_change_credit_fixed_fee":null,"ach_notice_of_change_debit_fixed_fee":null,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":null,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":null,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":null,"ancillary_fixed_fee_primary":null,"ancillary_fixed_fee_secondary":null,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":20,"card_account_updater_fixed_fee":null,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":null,"charge_all_reversal_requests":null,"charge_all_transfer_requests":null,"charge_dues_assessments":null,"charge_interchange":true,"compliance_forms_overdue_fixed_fee":null,"diners_club_basis_points":null,"diners_club_charge_interchange":null,"diners_club_fixed_fee":null,"discover_assessments_basis_points":null,"discover_basis_points":null,"discover_charge_dues_assessments":null,"discover_charge_interchange":null,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":null,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":3000,"dispute_inquiry_fixed_fee":null,"eft_basis_points":null,"eft_basis_points_fee_limit":null,"eft_credit_return_fixed_fee":null,"eft_debit_return_fixed_fee":null,"eft_fixed_fee":null,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":null,"externally_funded_fixed_fee":null,"fixed_fee":10,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":null,"interac_fixed_fee":null,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":null,"jcb_charge_interchange":null,"jcb_fixed_fee":null,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":null,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":null,"mastercard_fixed_fee":null,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":null,"visa_charge_dues_assessments":null,"visa_charge_interchange":null,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":null,"visa_kilobyte_access_fixed_fee":null,"_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPfjUi5vg3omQMKtS6QC3VDx"}}},{"id":"FPuzPuREXN9GnN13VQn87dC8","created_at":"2026-09-25T20:05:07.46Z","updated_at":"2026-09-25T20:05:07.46Z","ach_basis_points":20,"ach_basis_points_fee_limit":null,"ach_credit_return_fixed_fee":500,"ach_debit_return_fixed_fee":500,"ach_fixed_fee":50,"ach_notice_of_change_credit_fixed_fee":null,"ach_notice_of_change_debit_fixed_fee":null,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":null,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":null,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":null,"ancillary_fixed_fee_primary":null,"ancillary_fixed_fee_secondary":null,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":20,"card_account_updater_fixed_fee":null,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":null,"charge_all_reversal_requests":null,"charge_all_transfer_requests":null,"charge_dues_assessments":null,"charge_interchange":true,"compliance_forms_overdue_fixed_fee":null,"diners_club_basis_points":null,"diners_club_charge_interchange":null,"diners_club_fixed_fee":null,"discover_assessments_basis_points":null,"discover_basis_points":null,"discover_charge_dues_assessments":null,"discover_charge_interchange":null,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":null,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":3000,"dispute_inquiry_fixed_fee":null,"eft_basis_points":null,"eft_basis_points_fee_limit":null,"eft_credit_return_fixed_fee":null,"eft_debit_return_fixed_fee":null,"eft_fixed_fee":null,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":null,"externally_funded_fixed_fee":null,"fixed_fee":10,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":null,"interac_fixed_fee":null,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":null,"jcb_charge_interchange":null,"jcb_fixed_fee":null,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":null,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":null,"mastercard_fixed_fee":null,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":null,"visa_charge_dues_assessments":null,"visa_charge_interchange":null,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":null,"visa_kilobyte_access_fixed_fee":null,"_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuzPuREXN9GnN13VQn87dC8"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/fee_profiles?limit=3&after_cursor=FPuzPuREXN9GnN13VQn87dC8"}},"page":{"limit":3,"next_cursor":"FPuzPuREXN9GnN13VQn87dC8"}},"key":"List of Fee Profiles","summary":"List of Fee Profiles","id":"paths/~1fee_profiles/get/responses/200/content/application~1json/examples/List of Fee Profiles"},"paths/~1fee_profiles/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1fee_profiles/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1fee_profiles/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1fee_profiles/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1fee_profiles/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1fee_profiles/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1fee_profiles/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1fee_profiles/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1fee_profiles~1{fee_profile_id}/get/responses/200/content/application~1json/examples/Fee Profile":{"value":{"id":"FPmH8SgwcrgpV595sojbKXNB","created_at":"2026-09-25T20:05:06.83Z","updated_at":"2026-09-25T20:05:06.83Z","ach_basis_points":30,"ach_basis_points_fee_limit":50,"ach_credit_return_fixed_fee":25,"ach_debit_return_fixed_fee":30,"ach_fixed_fee":40,"ach_notice_of_change_credit_fixed_fee":12,"ach_notice_of_change_debit_fixed_fee":25,"ach_validation_plaid_fixed_fee":null,"afterpay_basis_points":null,"afterpay_fixed_fee":null,"american_express_assessment_basis_points":null,"american_express_basis_points":10,"american_express_charge_dues_assessments":null,"american_express_charge_interchange":true,"american_express_externally_funded_basis_points":null,"american_express_externally_funded_fixed_fee":null,"american_express_fixed_fee":15,"ancillary_fixed_fee_primary":32,"ancillary_fixed_fee_secondary":80,"application":"APc9vhYcPsRuTSpKD9KpMtPe","basis_points":20,"card_account_updater_fixed_fee":null,"card_cross_border_basis_points":15,"card_cross_border_fixed_fee":30,"card_name_verification_fixed_fee":null,"card_network_token_fixed_fee":null,"cash_app_pay_basis_points":null,"cash_app_pay_fixed_fee":null,"charge_all_authorization_requests":true,"charge_all_reversal_requests":true,"charge_all_transfer_requests":true,"charge_dues_assessments":true,"charge_interchange":false,"compliance_forms_overdue_fixed_fee":20,"diners_club_basis_points":90,"diners_club_charge_interchange":true,"diners_club_fixed_fee":25,"discover_assessments_basis_points":null,"discover_basis_points":12,"discover_charge_dues_assessments":null,"discover_charge_interchange":true,"discover_data_usage_fixed_fee":null,"discover_externally_funded_basis_points":null,"discover_externally_funded_fixed_fee":null,"discover_fixed_fee":35,"discover_network_authorization_fixed_fee":null,"dispute_fixed_fee":1500,"dispute_inquiry_fixed_fee":1500,"eft_basis_points":25,"eft_basis_points_fee_limit":20,"eft_credit_return_fixed_fee":35,"eft_debit_return_fixed_fee":30,"eft_fixed_fee":15,"eft_validation_plaid_fixed_fee":null,"externally_funded_basis_points":15,"externally_funded_fixed_fee":20,"fixed_fee":20,"gross_monthly_fees_ach_basis_points":null,"gross_monthly_fees_ach_fixed_fee":null,"gross_monthly_fees_card_basis_points":null,"gross_monthly_fees_card_fixed_fee":null,"gross_monthly_fees_eft_basis_points":null,"gross_monthly_fees_eft_fixed_fee":null,"interac_basis_points":20,"interac_fixed_fee":25,"invoice_ach_basis_points":null,"invoice_ach_basis_points_fee_limit":null,"invoice_ach_fixed_fee":null,"invoice_card_basis_points":null,"invoice_card_fixed_fee":null,"invoice_eft_basis_points":null,"invoice_eft_basis_points_fee_limit":null,"invoice_eft_fixed_fee":null,"jcb_basis_points":11,"jcb_charge_interchange":true,"jcb_fixed_fee":20,"mastercard_acquirer_fees_basis_points":null,"mastercard_assessments_over1k_basis_points":null,"mastercard_assessments_under1k_basis_points":null,"mastercard_basis_points":30,"mastercard_charge_dues_assessments":null,"mastercard_charge_interchange":true,"mastercard_fixed_fee":18,"payment_instrument_tokenization_fixed_fee":null,"qualified_tiers":null,"rounding_mode":"AGGREGATE","settlement_funding_transfer_ach_basis_points":null,"settlement_funding_transfer_ach_basis_points_fee_limit":null,"settlement_funding_transfer_ach_credit_return_fixed_fee":null,"settlement_funding_transfer_ach_debit_return_fixed_fee":null,"settlement_funding_transfer_ach_fixed_fee":null,"settlement_funding_transfer_eft_basis_points":null,"settlement_funding_transfer_eft_basis_points_fee_limit":null,"settlement_funding_transfer_eft_credit_return_fixed_fee":null,"settlement_funding_transfer_eft_debit_return_fixed_fee":null,"settlement_funding_transfer_eft_fixed_fee":null,"settlement_funding_transfer_instant_payout_card_basis_points":null,"settlement_funding_transfer_instant_payout_card_basis_points_fee_limit":null,"settlement_funding_transfer_instant_payout_card_fixed_fee":null,"settlement_funding_transfer_noc_credit_fixed_fee":null,"settlement_funding_transfer_noc_debit_fixed_fee":null,"settlement_funding_transfer_same_day_ach_basis_points":null,"settlement_funding_transfer_same_day_ach_basis_points_fee_limit":null,"settlement_funding_transfer_same_day_ach_fixed_fee":null,"subscription_ach_basis_points":null,"subscription_ach_basis_points_fee_limit":null,"subscription_ach_fixed_fee":null,"subscription_card_basis_points":null,"subscription_card_fixed_fee":null,"subscription_eft_basis_points":null,"subscription_eft_basis_points_fee_limit":null,"subscription_eft_fixed_fee":null,"tags":{},"third_party_gateway_cybersource_basis_points":null,"third_party_gateway_cybersource_fixed_fee":null,"visa_acquirer_processing_fixed_fee":null,"visa_assessments_basis_points":null,"visa_base_II_credit_voucher_fixed_fee":null,"visa_base_II_system_file_transmission_fixed_fee":null,"visa_basis_points":10,"visa_charge_dues_assessments":null,"visa_charge_interchange":true,"visa_credit_voucher_fixed_fee":null,"visa_fixed_fee":20,"visa_kilobyte_access_fixed_fee":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmH8SgwcrgpV595sojbKXNB"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Fee Profile","summary":"Fee Profile","id":"paths/~1fee_profiles~1{fee_profile_id}/get/responses/200/content/application~1json/examples/Fee Profile"},"paths/~1fee_profiles~1{fee_profile_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1fee_profiles~1{fee_profile_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1fee_profiles~1{fee_profile_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1fee_profiles~1{fee_profile_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1fee_profiles~1{fee_profile_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"FPuizPqrhzYLbmJm88u7aqfj was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1fee_profiles~1{fee_profile_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1fee_profiles~1{fee_profile_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1fee_profiles~1{fee_profile_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1files/post/requestBody/content/application~1json/examples/File":{"value":{"display_name":"Bank Statement","linked_to":"MUvWVhLpLj9w7kV1EXA7yvzc","type":"BANK_STATEMENT_ONE_MONTH"},"key":"File","summary":"File","id":"paths/~1files/post/requestBody/content/application~1json/examples/File"},"paths/~1files/post/responses/201/content/application~1json/examples/File":{"value":{"id":"FILE_s2v7UfDADTTNgES4ELy5Fm","status":"REQUIRES_UPLOAD","created_at":"2026-09-25T20:36:45.129905Z","updated_at":"2026-09-25T20:36:45.129905Z","linked_type":"MERCHANT","linked_to":"MUvWVhLpLj9w7kV1EXA7yvzc","extension":null,"display_name":"Bank Statement","type":"BANK_STATEMENT_ONE_MONTH","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","tags":{},"identity_id":"IDnT3ff71VShf6dB2ShcPozq","entity_id":null,"entity_type":null,"size_in_bytes":null,"file_name":null},"key":"File","summary":"File","id":"paths/~1files/post/responses/201/content/application~1json/examples/File"},"paths/~1files/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1files/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1files/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1files/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1files/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1files/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1files/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1files/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1files/get/responses/200/content/application~1json/examples/List of Files":{"value":{"_embedded":{"files":[{"id":"FILE_5MYsqaNVU9sLi8AHBwFezf","status":"UPLOADED","created_at":"2026-09-25T20:39:06.14057Z","updated_at":"2026-09-25T20:39:17.836619Z","linked_type":"MERCHANT","linked_to":"MUp8mcM12Wt4amchzDgAF564","extension":"pdf","display_name":"PCI_SAQ_A_b5443e","type":"PCI_DOCUMENT","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","tags":{},"identity_id":"IDboULhhX8xeGvqdPa8r7XtV","entity_id":null,"entity_type":null,"size_in_bytes":1451814,"file_name":null},{"id":"FILE_5L9Ugdwg6YbCHm4Nd7jQ4M","status":"UPLOADED","created_at":"2026-09-25T20:39:05.714305Z","updated_at":"2026-09-25T20:39:17.972343Z","linked_type":"MERCHANT","linked_to":"MUgyFrCDNuiZdAMPMXB1tQRS","extension":"pdf","display_name":"PCI_SAQ_A_6b7fc7","type":"PCI_DOCUMENT","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","tags":{},"identity_id":"IDvapsWuebxpnk9PszikFwJQ","entity_id":null,"entity_type":null,"size_in_bytes":1451814,"file_name":null},{"id":"FILE_5KPxoiRnuH5PY54KK1PbZG","status":"UPLOADED","created_at":"2026-09-25T20:39:05.636076Z","updated_at":"2026-09-25T20:39:17.382559Z","linked_type":"MERCHANT","linked_to":"MUvQKqSGX7cKEWACFGzBmYj5","extension":"pdf","display_name":"PCI_SAQ_A_94f0d8","type":"PCI_DOCUMENT","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","tags":{},"identity_id":"IDbR8T8KH49At6sTBMnFhddK","entity_id":null,"entity_type":null,"size_in_bytes":1451814,"file_name":null}]},"page":{"limit":3,"next_cursor":"FILE_5KPxoiRnuH5PY54KK1PbZG"}},"key":"List of Files","summary":"List of Files","id":"paths/~1files/get/responses/200/content/application~1json/examples/List of Files"},"paths/~1files/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1files/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1files/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1files/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1files/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1files/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1files/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1files/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1files~1{file_id}/get/responses/200/content/application~1json/examples/File":{"value":{"id":"FILE_s2v7UfDADTTNgES4ELy5Fm","status":"REQUIRES_UPLOAD","created_at":"2026-09-25T20:36:45.129905Z","updated_at":"2026-09-25T20:36:45.129905Z","linked_type":"MERCHANT","linked_to":"MUvWVhLpLj9w7kV1EXA7yvzc","extension":null,"display_name":"Bank Statement","type":"BANK_STATEMENT_ONE_MONTH","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","tags":{},"identity_id":"IDnT3ff71VShf6dB2ShcPozq","entity_id":null,"entity_type":null,"size_in_bytes":null,"file_name":null},"key":"File","summary":"File","id":"paths/~1files~1{file_id}/get/responses/200/content/application~1json/examples/File"},"paths/~1files~1{file_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1files~1{file_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1files~1{file_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1files~1{file_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1files~1{file_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"FILE_nWs5V6yyBVAyBe2vNWcqzw was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1files~1{file_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1files~1{file_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1files~1{file_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1files~1{file_id}~1external_links/get/responses/200/content/application~1json/examples/List of External Links":{"value":{"_embedded":{"external_links":[{"id":"EL_x7bMJeEgJPwtvQkdkAzFVg","created_at":"2026-09-04T12:13:05.705621Z","url":"https://finix-file-production-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUmfEGv5bMpSJ9k5TFRUjkmm/BANK_STATEMENT/FILE_nWs5V6yyBVAyBe2vNWcqzw/file?response-content-disposition=inline%3Bfilename%3Dbankstatementjanuary2024.jpg&response-content-type=image%2Fjpg&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECwaCXVzLWVhc3QtMiJHMEUCIQDMEXbMBXHdkXJqXgPy8avgdP5crGIctGfVlMsdShcC7AIgRfHs%2FpRjniCtAdmpRK0Q0p6eYQNb%2FJdM8idGwGxJDPoqhAUI9P%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARACGgwzNzU2MzU1NzAwNzAiDCgHWA%2FUgvTPyNq%2F8yrYBHM%2BlfTm66TQ9%2BeRwPPLuti9IphnMZwz3cM8IBGCMLgHIduAimXUt%2BsDlA%2BQB48l9R6kQYl3jX8T%2B1PqaOvdOEew5WHmqfW66Eml8N%2FNQat7d9YdEL9GqqLrq36J7YNHW7M%2Fwky7%2FujbFnrYONPqwGiTjrQZ3sibiCGv1g3pkYAObYuwffnr0XgUvlAQSD27oTERXcTQ44wL1pWMXLQJmmubdA77WnS0wDATmT9D4rtlnWm%2Bdc05GYcWpwlw66iDRUdJ54Sj%2FEok%2FIdC03%2BneR9mHCdBQd86wj7OmdOJofERjn2HkmeeHZ0M6o4xkCQyLXphars6nOQz03Df2%2BC0gQTJhbgFt0eNMdcNHPm34jR9PCLaFE08%2BSGfZvRmSy%2BgFR20vYEXb6Ew7z8YnWK3ZVoDO%2FWoC9VF2ir3OGRgyfA7zmg3W6WK3Ez1touN4vNKsfz4aRuQ%2B2oFo3W7oOtGAWZiHv%2BtED6HNXeH9amCsn%2Fdnn8hnR26jxmIX9%2FIzlNuVI6FNsTKsWd5payBMko9NDK9sndavZUgB6dVhJSRla%2BQoosoZ6mJpliB71JWwf7KbP1YehmGfHlJIG%2FcADRgC14FphiSHSTvYucYlzgP5y27KKKaNE9tZw%2BdSEPNxrmipAIEVrHFGo0Z6VtlN4r%2FSCTaZ9tYPpO2BSPNsjUhNwcsnzy9FN6riAa9s6YdeLKxujOs1485jT8Y3OZckwsytmiEAzVSHDoPtfo5semDAicOxpUBpPwwTVz6Xz2BEv0QWyDRuEAS%2F%2BPQU0Yy1yX8ycIw7LVT52H1czDh5erUBjqYAYbJbuM5OzjRZ90u9rdMdN%2BJXsMa5sWlmTOFmIcjodmYGM6Ir2vcSqcem4fzPCn0QGDkSPn9znRCS4Mb%2FOWynS%2BCw0Ew%2BlWL4GN2qEkc4CSHm7x4lYs7CUdnW1%2BQA8ypQDvC5VHhouhI58xQ0oQrnJ6veQzutHf6DzdY6zf7KH0Y%2FF3%2FvRGsa6JEoj9Vlqu93itF9z5kf%2B19&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260904T121305Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1799&X-Amz-Credential=ASIAVO5M75WLE22YFHJL%2F20260904%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=3a8361b004bd804ea4f4c24feb4666d917f32a2a31ebc2d92eeba683c22db4ce","type":"VIEW","expires_at":"2026-09-04T12:43:05.699616Z","user_id":"USfdccsr1Z5iVbXDyYt7hjZZ","file_id":"FILE_nWs5V6yyBVAyBe2vNWcqzw","duration":null,"tags":{},"expired":true},{"id":"EL_jgM9pmVNCqvxHWC1Nn3pvX","created_at":"2025-10-08T13:34:56.052128Z","url":"https://finix-file-production-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUmfEGv5bMpSJ9k5TFRUjkmm/BANK_STATEMENT/FILE_nWs5V6yyBVAyBe2vNWcqzw/file?response-content-disposition=inline%3Bfilename%3Dbankstatementjanuary2024.jpg&response-content-type=image%2Fjpg&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECUaCXVzLWVhc3QtMiJIMEYCIQCBFrnxmwPQRgI%2F7Oz6yQMYwKMyIPqA9LeACjF4h6W3oQIhAMn6%2BWsZBzkO1wxbbDnkh6lH4hYiuIOgMK%2Bbz8ulWim1KoIFCL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQAhoMMzc1NjM1NTcwMDcwIgzGtb1NhD1nbGpPZTIq1gSErLcBuoXB6fJPTfk2oI8omo%2Bmp%2FlTPUQSyNVajjyHcRGionCsJciNqCsQuXBoBrjGlKHQyln4fmYrz1SKis305jpYJv3SQLiV5Fg%2F2SFPKLfEkIe6SowqLeV1LExYrvAwzqe3eMY4HFs57rkggvjEWQkwZ9rQSjZREXntHR%2FGiMq7v5hx7K31bR7TEOtSYPGuiVCjCsVKaAIlW0GunDx9WXb1YvUVxtMMABF8UKWxAeRDdnq2tNzF7vJkHqn9KBo8wr0C1cJWm4ZPzqF4Ps8u21tijnGwgnJnKbuCeZ2gnRyEvHAhxoXhDuV8uNYdGwWmtJHhR8bNZaX7HTfN1mYaaHZsdKR4clZQS5TH%2F72jBPi5RI1bFsnN%2BkC2th0l3NcCLhMIil9EKkvTKKaPrE0d2IdsyNFTarSnEzNhXyx0qa4I2tiMmikrRlsDL0DeGLKzTzjbogrT3RYAO6%2BmFrPkiO5MvcyVGXjTs8iuwUKAF1zSOBoV2zgDiEQ3gGeuzZCgKc9wqBj52pSkAqIJp02V%2F1Po8Fay5b3U2hYG4vGIeiko4ZnSZyrGGPsAhldS28Qb%2Bdc8IYYYCf57%2Bo%2B%2FaQS7ad241WJhgfq45G1KogfUrCh6VMMgHtVIDxM2vv20cPF0wWH3Z8CPLgTE2E5%2F0ZNMTkkY2Rd0WFrBOAGoWV1UEPZPY5bLFz39SOV9ZcUkuBKGGbzHTUb%2F2I2KuPHXsaG%2Fth79qH1NreOMvHR6LXXrVKHzViUjBOPSuJcVkQHLByLP3ercZo1LUd2A%2Bs0ilP4axxdc4i9KMM%2FMmccGOpkBcamBGBFjKHa0CcZ%2F5ltRLT8PmxvO2ZXXEPo7DVb0urVoGW3JdXVVQ0agFRmP9%2BqmYIA1leAa7wI%2BrFLbDblI%2B1Gjwl3QlNmdnOAFWLA1t2QqYrhB%2BKKIp9ViNh14wSaRbQr6zYNymdwh8YHpqVe5uXSPp1IiSzbgsK4eFbzQOA5lk2xp1k97x72HVivW1AU99xYkDdCtwyt2&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251008T133456Z&X-Amz-SignedHeaders=host&X-Amz-Expires=71999&X-Amz-Credential=ASIAVO5M75WLH5A7UGNV%2F20251008%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=fa28eaa0b2662aa5f21f02e42c06b31484157d27fa56979480de8356aaf6d97d","type":"VIEW","expires_at":"2025-10-09T09:34:56.044954Z","user_id":"USfdccsr1Z5iVbXDyYt7hjZZ","file_id":"FILE_nWs5V6yyBVAyBe2vNWcqzw","duration":null,"tags":{},"expired":true},{"id":"EL_iTQsiPpvtiE77BcCQ78e89","created_at":"2025-10-08T13:34:50.911504Z","url":"https://finix-file-production-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUmfEGv5bMpSJ9k5TFRUjkmm/BANK_STATEMENT/FILE_nWs5V6yyBVAyBe2vNWcqzw/file?response-content-disposition=inline%3Bfilename%3Dbankstatementjanuary2024.jpg&response-content-type=image%2Fjpg&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECUaCXVzLWVhc3QtMiJIMEYCIQCBFrnxmwPQRgI%2F7Oz6yQMYwKMyIPqA9LeACjF4h6W3oQIhAMn6%2BWsZBzkO1wxbbDnkh6lH4hYiuIOgMK%2Bbz8ulWim1KoIFCL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEQAhoMMzc1NjM1NTcwMDcwIgzGtb1NhD1nbGpPZTIq1gSErLcBuoXB6fJPTfk2oI8omo%2Bmp%2FlTPUQSyNVajjyHcRGionCsJciNqCsQuXBoBrjGlKHQyln4fmYrz1SKis305jpYJv3SQLiV5Fg%2F2SFPKLfEkIe6SowqLeV1LExYrvAwzqe3eMY4HFs57rkggvjEWQkwZ9rQSjZREXntHR%2FGiMq7v5hx7K31bR7TEOtSYPGuiVCjCsVKaAIlW0GunDx9WXb1YvUVxtMMABF8UKWxAeRDdnq2tNzF7vJkHqn9KBo8wr0C1cJWm4ZPzqF4Ps8u21tijnGwgnJnKbuCeZ2gnRyEvHAhxoXhDuV8uNYdGwWmtJHhR8bNZaX7HTfN1mYaaHZsdKR4clZQS5TH%2F72jBPi5RI1bFsnN%2BkC2th0l3NcCLhMIil9EKkvTKKaPrE0d2IdsyNFTarSnEzNhXyx0qa4I2tiMmikrRlsDL0DeGLKzTzjbogrT3RYAO6%2BmFrPkiO5MvcyVGXjTs8iuwUKAF1zSOBoV2zgDiEQ3gGeuzZCgKc9wqBj52pSkAqIJp02V%2F1Po8Fay5b3U2hYG4vGIeiko4ZnSZyrGGPsAhldS28Qb%2Bdc8IYYYCf57%2Bo%2B%2FaQS7ad241WJhgfq45G1KogfUrCh6VMMgHtVIDxM2vv20cPF0wWH3Z8CPLgTE2E5%2F0ZNMTkkY2Rd0WFrBOAGoWV1UEPZPY5bLFz39SOV9ZcUkuBKGGbzHTUb%2F2I2KuPHXsaG%2Fth79qH1NreOMvHR6LXXrVKHzViUjBOPSuJcVkQHLByLP3ercZo1LUd2A%2Bs0ilP4axxdc4i9KMM%2FMmccGOpkBcamBGBFjKHa0CcZ%2F5ltRLT8PmxvO2ZXXEPo7DVb0urVoGW3JdXVVQ0agFRmP9%2BqmYIA1leAa7wI%2BrFLbDblI%2B1Gjwl3QlNmdnOAFWLA1t2QqYrhB%2BKKIp9ViNh14wSaRbQr6zYNymdwh8YHpqVe5uXSPp1IiSzbgsK4eFbzQOA5lk2xp1k97x72HVivW1AU99xYkDdCtwyt2&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251008T133450Z&X-Amz-SignedHeaders=host&X-Amz-Expires=35999&X-Amz-Credential=ASIAVO5M75WLH5A7UGNV%2F20251008%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=73f8b68f703f7d586ab78c33206df14429f5d381c73c2d4c4e480f4a28741b4e","type":"VIEW","expires_at":"2025-10-08T23:34:50.888151Z","user_id":"USfdccsr1Z5iVbXDyYt7hjZZ","file_id":"FILE_nWs5V6yyBVAyBe2vNWcqzw","duration":null,"tags":{},"expired":true}]},"page":{"limit":3,"next_cursor":"EL_iTQsiPpvtiE77BcCQ78e89"}},"key":"List of External Links","summary":"List of External Links","id":"paths/~1files~1{file_id}~1external_links/get/responses/200/content/application~1json/examples/List of External Links"},"paths/~1files~1{file_id}~1external_links/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1files~1{file_id}~1external_links/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1files~1{file_id}~1external_links/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1files~1{file_id}~1external_links/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1files~1{file_id}~1external_links/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1files~1{file_id}~1external_links/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1files~1{file_id}~1external_links/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1files~1{file_id}~1external_links/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Upload":{"value":{"duration":15,"type":"UPLOAD"},"key":"External Link - Upload","summary":"External Link - Upload","id":"paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Upload"},"paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Download":{"value":{"duration":20,"type":"DOWNLOAD"},"key":"External Link - Download","summary":"External Link - Download","id":"paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - Download"},"paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - View":{"value":{"duration":30,"type":"VIEW"},"key":"External Link - View","summary":"External Link - View","id":"paths/~1files~1{file_id}~1external_links/post/requestBody/content/application~1json/examples/External Link - View"},"paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Upload":{"value":{"id":"EL_2dbrRkSCZ4NoQHCdHRJats","created_at":"2026-09-25T20:38:17.465048Z","url":"https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUvWVhLpLj9w7kV1EXA7yvzc/BANK_STATEMENT_ONE_MONTH/FILE_wAtNe1Bw9R4sNgt7jxwS2Y/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjECwaCXVzLWVhc3QtMiJGMEQCIBN4janzxr5UwulmRDVrJgqKlI7IDbe6e45xvZDF5ziIAiAUGWj0b2nl5h%2FuGImkDzrmVtevCFb3RMSS8qt%2B1cvqxCqEBQj1%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAIaDDM3NTYzNTU3MDA3MCIM07Q9vvP1zkxH2Y%2FSKtgEHi6%2FqnWoXwVWuygSNn3qNVyTe6zfeSmAs8A3R1BNnXuRpptGVwCS2g5yds%2BeTWMJLZ4lT7n3%2F89zeV6utBgOzveO0K9VLFfLDi2WnCyykEe3K%2BGqgKB7KRS04jd06rLzSUEFEmmnfXPW5Mr0dDl%2FPEkrwhoXOdePbaU2%2BzqxjbYMJB43CFXZ6YJ3PPcfHUAy1bdOyjRG1Gs7dpiCftif9HisHDkLwP6c14%2BY3RlcgM4jHSDg%2FqmHclPLR7tbUQoom%2F2WGG%2BgBx8VbLRgGDLfVl1e4Oji8%2FdpSC7yHOYFuZFKaL4f3El68VbJKF0b%2B68esZMRoxgwMBERiarLA%2BP8PYeeFkx9aOBKLOJfmPIBT4z3cD8ONJVM5Ujv4bBV0aHAMExwg8gWjBgd6vZAoLQ1wQA6Xt%2FFgnO7TLlAz2i0uLQbrt25MhD2F2%2B%2BMUud3hSbnwSP8IYbLBia4ONFB6t1U6oJqV6ZsujD0Eq8SeZ01bC2noaTVz1orRRtQK3A49RhYLS7CC6O5WoNqZglATHT99LHUziQ4TI%2BXQUOIjufEigdobWCkk1thJb2C%2BlThUKBLnKa4Hc4FvZg2WXW3qs31zIn7P%2F39bB1MuYMtEZledtKXJZgMB5a14ieiU6pHNeQIjBEU20NBql9etKiPAx6IGbiH6uYZ%2B3QBGEleiHsOTSOzP1FRIalW7DqY%2FtZBNBez5xgFoYExll9HJ0yfmIPoWyh%2FNNS73fm4AZbKPEY3ejlrJnjr9OXAusNdxc1qSsMrJaY1ICNKa%2B1syvUZiyy6U6%2BfJqSXyQLMNWl29UGOpkB651MFxquhGYvFRg025JdFgUW%2BaWkWsemxR5Disl1MXQ%2FI1pup5PpI5wXjITkmDc1qkF%2BHfoonx7nChLC5EwfRg1lyTAF%2FUp3uNcZux3iGDh4doZpNIAtsGUh7qrRat4qdKV2tT4i5xtP44neBukaczeCuSANyj2NBad9nyjofi0x5h1uEdKV2tr2Bs3JPtrGyx89CItbePF3&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260925T203817Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLNEXS3GJT%2F20260925%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=8aa3efd24bdcb05d2dbde527545258675afad0211399e5f4a4b9a21bf68c1042","type":"UPLOAD","expires_at":"2026-09-25T20:53:17.46086Z","user_id":"USfdccsr1Z5iVbXDyYt7hjZZ","file_id":"FILE_wAtNe1Bw9R4sNgt7jxwS2Y","duration":null,"tags":{},"expired":false},"key":"External Link - Upload","summary":"External Link - Upload","id":"paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Upload"},"paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Download":{"value":{"id":"EL_wyXtzkU8XhvkePkK4o8AR5","created_at":"2026-09-25T20:37:46.844324Z","url":"https://finix-file-production-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUvWVhLpLj9w7kV1EXA7yvzc/BANK_STATEMENT_ONE_MONTH/FILE_s2v7UfDADTTNgES4ELy5Fm/file?response-content-disposition=attachment%3Bfilename%3Dbankstatement.csv&response-content-type=text%2Fcsv&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECwaCXVzLWVhc3QtMiJGMEQCIBN4janzxr5UwulmRDVrJgqKlI7IDbe6e45xvZDF5ziIAiAUGWj0b2nl5h%2FuGImkDzrmVtevCFb3RMSS8qt%2B1cvqxCqEBQj1%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAIaDDM3NTYzNTU3MDA3MCIM07Q9vvP1zkxH2Y%2FSKtgEHi6%2FqnWoXwVWuygSNn3qNVyTe6zfeSmAs8A3R1BNnXuRpptGVwCS2g5yds%2BeTWMJLZ4lT7n3%2F89zeV6utBgOzveO0K9VLFfLDi2WnCyykEe3K%2BGqgKB7KRS04jd06rLzSUEFEmmnfXPW5Mr0dDl%2FPEkrwhoXOdePbaU2%2BzqxjbYMJB43CFXZ6YJ3PPcfHUAy1bdOyjRG1Gs7dpiCftif9HisHDkLwP6c14%2BY3RlcgM4jHSDg%2FqmHclPLR7tbUQoom%2F2WGG%2BgBx8VbLRgGDLfVl1e4Oji8%2FdpSC7yHOYFuZFKaL4f3El68VbJKF0b%2B68esZMRoxgwMBERiarLA%2BP8PYeeFkx9aOBKLOJfmPIBT4z3cD8ONJVM5Ujv4bBV0aHAMExwg8gWjBgd6vZAoLQ1wQA6Xt%2FFgnO7TLlAz2i0uLQbrt25MhD2F2%2B%2BMUud3hSbnwSP8IYbLBia4ONFB6t1U6oJqV6ZsujD0Eq8SeZ01bC2noaTVz1orRRtQK3A49RhYLS7CC6O5WoNqZglATHT99LHUziQ4TI%2BXQUOIjufEigdobWCkk1thJb2C%2BlThUKBLnKa4Hc4FvZg2WXW3qs31zIn7P%2F39bB1MuYMtEZledtKXJZgMB5a14ieiU6pHNeQIjBEU20NBql9etKiPAx6IGbiH6uYZ%2B3QBGEleiHsOTSOzP1FRIalW7DqY%2FtZBNBez5xgFoYExll9HJ0yfmIPoWyh%2FNNS73fm4AZbKPEY3ejlrJnjr9OXAusNdxc1qSsMrJaY1ICNKa%2B1syvUZiyy6U6%2BfJqSXyQLMNWl29UGOpkB651MFxquhGYvFRg025JdFgUW%2BaWkWsemxR5Disl1MXQ%2FI1pup5PpI5wXjITkmDc1qkF%2BHfoonx7nChLC5EwfRg1lyTAF%2FUp3uNcZux3iGDh4doZpNIAtsGUh7qrRat4qdKV2tT4i5xtP44neBukaczeCuSANyj2NBad9nyjofi0x5h1uEdKV2tr2Bs3JPtrGyx89CItbePF3&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260925T203746Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1199&X-Amz-Credential=ASIAVO5M75WLNEXS3GJT%2F20260925%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=4189c5604f6a23bc6ef799ff23f56fb1fe8ed18a19a368c48300e4664243bc6f","type":"DOWNLOAD","expires_at":"2026-09-25T20:57:46.841054Z","user_id":"USfdccsr1Z5iVbXDyYt7hjZZ","file_id":"FILE_s2v7UfDADTTNgES4ELy5Fm","duration":null,"tags":{},"expired":false},"key":"External Link - Download","summary":"External Link - Download","id":"paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - Download"},"paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - View":{"value":{"id":"EL_wvY6bfocaDaGBgMYSCQWGi","created_at":"2026-09-25T20:37:46.143989Z","url":"https://finix-file-production-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUvWVhLpLj9w7kV1EXA7yvzc/BANK_STATEMENT_ONE_MONTH/FILE_s2v7UfDADTTNgES4ELy5Fm/file?response-content-disposition=inline%3Bfilename%3Dbankstatement.csv&response-content-type=text%2Fcsv&X-Amz-Security-Token=IQoJb3JpZ2luX2VjECwaCXVzLWVhc3QtMiJHMEUCIQD%2F7k2ihXjO%2F3CmRVEof1tDQj4e2hdEY%2B7tA%2Bz5o5VadAIgHcirvO5iZZxOkpAnNfN8eWwDu7RkOyHyERn1UH5qFtwqhAUI9f%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARACGgwzNzU2MzU1NzAwNzAiDIUXXBMrQqHJqFw90irYBA2PflEFmleZV8YdrFQpGFwDvOoVNwWC2BYpOZ1wwxiGyzAI18YLzjOjhm1bTz3jX7pDr2KBbAKzG2fpXywQ6Dutj20DGeI40UqHW6655qKkB%2BhJs8dCHThmqkmlb6d6mg%2B6JycPqdLwe5T7uTN2BK1ggC%2FkfFH8HOATM94E3slBcOSxEjx2idZ8Dfhb67MA6rPuF%2F%2F9nbPVyVqC58Pq6dDNMNihnn6FsZ77eDtULiGAD0BDjIO%2FJAfZ4nUFyte245bZwj4lvT5zYaDoSmj47qfBpHMmd2Yppkd7%2FcJJyaRv%2FV3soE%2FvgbHep7XQLRMnffcV7XGTOn0pwkWtXpQ7otSnjedLoVbIgGp8vbF7Kw%2Frhh%2Br7iRTn%2BGS4508H57pvOeHQEGjKtTIUBz9gyjK3avBJfXJ0jPr4AG3BJ7whhiSRIUgHsWvMBPflQoacjDSsHJMhkdcFVM0bpg0KX9CulCk9MR1ASrKPkeMA3LSZQVzzYatHsRYR9qIy6hGCoQfTGa8BsaLvdRPVFPZ2DXoyoBby%2BHMvaZBXSLNsEwyqNP8sVoOvdbHLdvNOVV%2FO9oMOjnQy0M9GU3JT55NCH2pDSwOWU7M7lT%2Frb05zusOB%2BR65YLUDynTGOSZ%2Fv6UXmFkOPPp8fDYkeiduEkacrInRac2V42hFKl7jst1e%2F9TiCmPAnx34d3yg5deqRvCqeZvrjUyq5FzQIBgFUnS9b5ucZhWFmu7h0Yp9AF4qzw6z0z3QWcPYCg7XB2UEoggGo%2BHpuqpGZVzPKo1l%2Ffwfws43NlSu6PkE%2BccjzDXpdvVBjqYAXqxSqQ1bmojkdQfbtXIl5hLRaswfLf1ViszigWXbluPeTnOUcz0dff5rDq%2FH8FLfxrQ3hX80SuxDbAK5C4IQfMTtAsw8W%2FrTHxGtjMPTdXJ%2BEWDnLAh1Uov4Cye9D9NYF99wnJuibV%2F9ku26PRmfDrfvWufILHbgM7Pf2BsxM%2Bzlzx7%2BwRu%2FkX1%2FnhOrXoiPRhlkou0O89o&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260925T203746Z&X-Amz-SignedHeaders=host&X-Amz-Expires=1799&X-Amz-Credential=ASIAVO5M75WLMOHBZTZI%2F20260925%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=fc6143fde28f3636a6fde339b91e59cda397f77f33bc140ce6807e50caea7351","type":"VIEW","expires_at":"2026-09-25T21:07:46.130675Z","user_id":"USfdccsr1Z5iVbXDyYt7hjZZ","file_id":"FILE_s2v7UfDADTTNgES4ELy5Fm","duration":null,"tags":{},"expired":false},"key":"External Link - View","summary":"External Link - View","id":"paths/~1files~1{file_id}~1external_links/post/responses/201/content/application~1json/examples/External Link - View"},"paths/~1files~1{file_id}~1external_links/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1files~1{file_id}~1external_links/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1files~1{file_id}~1external_links/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1files~1{file_id}~1external_links/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1files~1{file_id}~1external_links/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1files~1{file_id}~1external_links/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1files~1{file_id}~1external_links/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1files~1{file_id}~1external_links/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploading":{"value":{"id":"FILE_s2v7UfDADTTNgES4ELy5Fm","status":"PENDING","created_at":"2026-09-25T20:36:45.129905Z","updated_at":"2026-09-25T20:36:45.498777Z","linked_type":"MERCHANT","linked_to":"MUvWVhLpLj9w7kV1EXA7yvzc","extension":"csv","display_name":"Bank Statement","type":"BANK_STATEMENT_ONE_MONTH","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","tags":{},"identity_id":"IDnT3ff71VShf6dB2ShcPozq","entity_id":null,"entity_type":null,"size_in_bytes":1539,"file_name":"bankstatement.csv"},"key":"File - Uploading","summary":"File - Uploading","id":"paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploading"},"paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploaded":{"value":{"id":"FILE_s2v7UfDADTTNgES4ELy5Fm","status":"UPLOADED","created_at":"2026-09-25T20:36:45.129905Z","updated_at":"2026-09-25T20:36:57.177258Z","linked_type":"MERCHANT","linked_to":"MUvWVhLpLj9w7kV1EXA7yvzc","extension":"csv","display_name":"Bank Statement","type":"BANK_STATEMENT_ONE_MONTH","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","tags":{},"identity_id":"IDnT3ff71VShf6dB2ShcPozq","entity_id":null,"entity_type":null,"size_in_bytes":1539,"file_name":"bankstatement.csv"},"key":"File - Uploaded","summary":"File - Uploaded","id":"paths/~1files~1{file_id}~1upload/post/responses/200/content/application~1json/examples/File - Uploaded"},"paths/~1files~1{file_id}~1upload/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/upload"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1files~1{file_id}~1upload/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1files~1{file_id}~1upload/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/upload"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1files~1{file_id}~1upload/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1files~1{file_id}~1upload/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/upload"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1files~1{file_id}~1upload/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1files~1{file_id}~1upload/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/upload"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1files~1{file_id}~1upload/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1files~1{file_id}~1download/get/responses/200/content/application~1octet-stream/example":{"value":{},"id":"paths/~1files~1{file_id}~1download/get/responses/200/content/application~1octet-stream/example"},"paths/~1files~1{file_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/download"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1files~1{file_id}~1download/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1files~1{file_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/download"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1files~1{file_id}~1download/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1files~1{file_id}~1download/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"FILE_nWs5V6yyBVAyBe2vNWcqzw was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/download"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1files~1{file_id}~1download/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1files~1{file_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/download"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1files~1{file_id}~1download/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/200/content/application~1json/examples/External Link":{"value":{"id":"EL_2dbrRkSCZ4NoQHCdHRJats","created_at":"2026-09-25T20:38:17.465048Z","url":"https://finix-file-quarantine-sb.s3.us-east-2.amazonaws.com/MERCHANT/MUvWVhLpLj9w7kV1EXA7yvzc/BANK_STATEMENT_ONE_MONTH/FILE_wAtNe1Bw9R4sNgt7jxwS2Y/file?X-Amz-Security-Token=IQoJb3JpZ2luX2VjECwaCXVzLWVhc3QtMiJGMEQCIBN4janzxr5UwulmRDVrJgqKlI7IDbe6e45xvZDF5ziIAiAUGWj0b2nl5h%2FuGImkDzrmVtevCFb3RMSS8qt%2B1cvqxCqEBQj1%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAIaDDM3NTYzNTU3MDA3MCIM07Q9vvP1zkxH2Y%2FSKtgEHi6%2FqnWoXwVWuygSNn3qNVyTe6zfeSmAs8A3R1BNnXuRpptGVwCS2g5yds%2BeTWMJLZ4lT7n3%2F89zeV6utBgOzveO0K9VLFfLDi2WnCyykEe3K%2BGqgKB7KRS04jd06rLzSUEFEmmnfXPW5Mr0dDl%2FPEkrwhoXOdePbaU2%2BzqxjbYMJB43CFXZ6YJ3PPcfHUAy1bdOyjRG1Gs7dpiCftif9HisHDkLwP6c14%2BY3RlcgM4jHSDg%2FqmHclPLR7tbUQoom%2F2WGG%2BgBx8VbLRgGDLfVl1e4Oji8%2FdpSC7yHOYFuZFKaL4f3El68VbJKF0b%2B68esZMRoxgwMBERiarLA%2BP8PYeeFkx9aOBKLOJfmPIBT4z3cD8ONJVM5Ujv4bBV0aHAMExwg8gWjBgd6vZAoLQ1wQA6Xt%2FFgnO7TLlAz2i0uLQbrt25MhD2F2%2B%2BMUud3hSbnwSP8IYbLBia4ONFB6t1U6oJqV6ZsujD0Eq8SeZ01bC2noaTVz1orRRtQK3A49RhYLS7CC6O5WoNqZglATHT99LHUziQ4TI%2BXQUOIjufEigdobWCkk1thJb2C%2BlThUKBLnKa4Hc4FvZg2WXW3qs31zIn7P%2F39bB1MuYMtEZledtKXJZgMB5a14ieiU6pHNeQIjBEU20NBql9etKiPAx6IGbiH6uYZ%2B3QBGEleiHsOTSOzP1FRIalW7DqY%2FtZBNBez5xgFoYExll9HJ0yfmIPoWyh%2FNNS73fm4AZbKPEY3ejlrJnjr9OXAusNdxc1qSsMrJaY1ICNKa%2B1syvUZiyy6U6%2BfJqSXyQLMNWl29UGOpkB651MFxquhGYvFRg025JdFgUW%2BaWkWsemxR5Disl1MXQ%2FI1pup5PpI5wXjITkmDc1qkF%2BHfoonx7nChLC5EwfRg1lyTAF%2FUp3uNcZux3iGDh4doZpNIAtsGUh7qrRat4qdKV2tT4i5xtP44neBukaczeCuSANyj2NBad9nyjofi0x5h1uEdKV2tr2Bs3JPtrGyx89CItbePF3&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260925T203817Z&X-Amz-SignedHeaders=host&X-Amz-Expires=899&X-Amz-Credential=ASIAVO5M75WLNEXS3GJT%2F20260925%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Signature=8aa3efd24bdcb05d2dbde527545258675afad0211399e5f4a4b9a21bf68c1042","type":"UPLOAD","expires_at":"2026-09-25T20:53:17.46086Z","user_id":"USfdccsr1Z5iVbXDyYt7hjZZ","file_id":"FILE_wAtNe1Bw9R4sNgt7jxwS2Y","duration":null,"tags":{},"expired":false},"key":"External Link","summary":"External Link","id":"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/200/content/application~1json/examples/External Link"},"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links/EL_9NjudbF2eCjjdKnPu3UjL1"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links/EL_9NjudbF2eCjjdKnPu3UjL1"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"EL_9NjudbF2eCjjdKnPu3UjL1 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links/EL_9NjudbF2eCjjdKnPu3UjL1"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/files/FILE_nWs5V6yyBVAyBe2vNWcqzw/external_links/EL_9NjudbF2eCjjdKnPu3UjL1"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1files~1{file_id}~1external_links~1{external_link_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1identities/post/requestBody/content/application~1json/examples/Seller (USA)":{"value":{"additional_underwriting_data":{"annual_ach_volume":200000,"average_ach_transfer_amount":200000,"average_card_transfer_amount":200000,"business_description":"SB3 vegan cafe","card_volume_distribution":{"card_present_percentage":30,"ecommerce_percentage":60,"mail_order_telephone_order_percentage":10},"credit_check_allowed":true,"credit_check_ip_address":"42.1.1.112","credit_check_timestamp":"2021-04-28T16:42:55Z","credit_check_user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10_14_6)","merchant_agreement_accepted":true,"merchant_agreement_ip_address":"42.1.1.113","merchant_agreement_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)","refund_policy":"MERCHANDISE_EXCHANGE_ONLY","volume_distribution_by_business_type":{"business_to_business_volume_percentage":100,"business_to_consumer_volume_percentage":0,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0}},"entity":{"ach_max_transaction_amount":1000000,"annual_card_volume":12000000,"business_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 8","postal_code":"94114","region":"CA"},"business_name":"Finix Flowers","business_phone":"+1 (408) 756-4497","business_tax_id":"123456789","business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Finix Flowers","dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Finix Flowers","email":"user@example.org","first_name":"John","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Smith","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 7","postal_code":"94114","region":"CA"},"phone":"14158885080","principal_percentage_ownership":50,"tax_id":"123456789","title":"CEO","url":"https://www.finix.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS"},"key":"Seller (USA)","summary":"Seller (USA)","id":"paths/~1identities/post/requestBody/content/application~1json/examples/Seller (USA)"},"paths/~1identities/post/requestBody/content/application~1json/examples/Seller (CAN)":{"value":{"additional_underwriting_data":{"average_card_transfer_amount":200000,"business_description":"Business offering video editing services.","card_volume_distribution":{"card_present_percentage":30,"ecommerce_percentage":60,"mail_order_telephone_order_percentage":10},"credit_check_allowed":true,"credit_check_ip_address":"42.1.1.112","credit_check_timestamp":"2021-04-28T16:42:55Z","credit_check_user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10_14_6)","merchant_agreement_accepted":true,"merchant_agreement_ip_address":"42.1.1.113","merchant_agreement_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)","refund_policy":"MERCHANDISE_EXCHANGE_ONLY","volume_distribution_by_business_type":{"business_to_business_volume_percentage":100,"business_to_consumer_volume_percentage":0,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0}},"entity":{"ach_max_transaction_amount":1000000,"annual_card_volume":12000000,"business_address":{"city":"Vancouver","country":"CAN","line1":"456 Elm Avenue","line2":null,"postal_code":"V6B 2L2","region":"BC"},"business_name":"Video Editing Services","business_phone":"+1 (416) 555-7890","business_tax_id":"123456789","business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Video Services","dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Video Editing Services","email":"info@video-editing-services.com","first_name":"Jerry","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Dunhill","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"city":"Vancouver","country":"CAN","line1":"987 Milo Street","line2":null,"postal_code":"V5K 1Z5","region":"BC"},"phone":"14158885080","principal_percentage_ownership":50,"tax_id":"123456789","title":"CEO","url":"https://www.video-editing-services.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS"},"key":"Seller (CAN)","summary":"Seller (CAN)","id":"paths/~1identities/post/requestBody/content/application~1json/examples/Seller (CAN)"},"paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Business)":{"value":{"entity":{"business_address":{"city":"Smalltown","country":"USA","line1":"7890 Oak Drive","line2":"Suite 101","postal_code":"75432","region":"TX"},"business_name":"Blue Horizon Technologies","doing_business_as":"B.H. Technologies","first_name":"John","last_name":"Jeremy","personal_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 7","postal_code":"94114","region":"CA"}},"identity_roles":["RECIPIENT"],"type":"BUSINESS"},"key":"Recipient (Business)","summary":"Recipient (Business)","id":"paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Business)"},"paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Personal)":{"value":{"entity":{"first_name":"John","last_name":"Jeremy","personal_address":{"city":"Springfield","country":"USA","line1":"789 Oak Drive","line2":null,"postal_code":"62704","region":"IL"}},"identity_roles":["RECIPIENT"],"type":"PERSONAL"},"key":"Recipient (Personal)","summary":"Recipient (Personal)","id":"paths/~1identities/post/requestBody/content/application~1json/examples/Recipient (Personal)"},"paths/~1identities/post/requestBody/content/application~1json/examples/Buyer":{"value":{"entity":{"email":"johnsmithbuyer@gmail.com","first_name":"John","last_name":"Smith","personal_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 7","postal_code":"94114","region":"CA"},"phone":"7147148784"},"identity_roles":["BUYER"],"type":"PERSONAL"},"key":"Buyer","summary":"Buyer","id":"paths/~1identities/post/requestBody/content/application~1json/examples/Buyer"},"paths/~1identities/post/requestBody/content/application~1json/examples/Buyer - Blank":{"value":{"entity":{}},"key":"Buyer - Blank","summary":"Buyer - Blank","id":"paths/~1identities/post/requestBody/content/application~1json/examples/Buyer - Blank"},"paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Personal)":{"value":{"entity":{"first_name":"Michael","last_name":"Johnson","personal_address":{"city":"Springfield","country":"USA","line1":"789 Oak Drive","line2":null,"postal_code":"62704","region":"IL"}},"identity_roles":["RECIPIENT","SENDER"],"type":"PERSONAL"},"key":"Sender & Recipient (Personal)","summary":"Sender & Recipient (Personal)","id":"paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Personal)"},"paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Business)":{"value":{"entity":{"business_address":{"city":"Smalltown","country":"USA","line1":"7890 Oak Drive","line2":"Suite 101","postal_code":"75432","region":"TX"},"business_name":"Blue Horizon Technologies","doing_business_as":"B.H. Technologies","first_name":"John","last_name":"Jeremy","personal_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 7","postal_code":"94114","region":"CA"}},"identity_roles":["RECIPIENT","SENDER"],"type":"BUSINESS"},"key":"Sender & Recipient (Business)","summary":"Sender & Recipient (Business)","id":"paths/~1identities/post/requestBody/content/application~1json/examples/Sender & Recipient (Business)"},"paths/~1identities/post/responses/201/content/application~1json/examples/Seller (USA)":{"value":{"id":"IDfC3Z9xVrniLsE6Hk4Zqhjv","created_at":"2026-09-30T00:02:15.54Z","updated_at":"2026-09-30T00:02:15.54Z","additional_underwriting_data":{"refund_policy":"MERCHANDISE_EXCHANGE_ONLY","credit_check_ip_address":"42.1.1.112","card_volume_distribution":{"card_present_percentage":30,"ecommerce_percentage":60,"mail_order_telephone_order_percentage":10},"average_ach_transfer_amount":200000,"average_card_transfer_amount":200000,"merchant_agreement_accepted":true,"merchant_agreement_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)","annual_card_volume":12000000,"merchant_agreement_ip_address":"42.1.1.113","annual_ach_volume":200000,"credit_check_allowed":true,"business_description":"SB3 vegan cafe","credit_check_user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10_14_6)","volume_distribution_by_business_type":{"business_to_business_volume_percentage":100,"business_to_consumer_volume_percentage":0,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0},"credit_check_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_timestamp":"2021-04-28T16:42:55Z"},"application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":1000000,"amex_mid":null,"annual_card_volume":12000000,"business_address":{"line1":"741 Douglass St","line2":"Apartment 8","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"business_name":"Finix Flowers","business_phone":"+1 (408) 756-4497","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Finix Flowers","discover_mid":null,"dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Finix Flowers","email":"user@example.org","first_name":"John","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Smith","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":"14158885080","principal_percentage_ownership":50,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.finix.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Seller (USA)","summary":"Seller (USA)","id":"paths/~1identities/post/responses/201/content/application~1json/examples/Seller (USA)"},"paths/~1identities/post/responses/201/content/application~1json/examples/Seller (CAN)":{"value":{"id":"IDheUNDYiYUNnR2CMCjYJdyK","created_at":"2026-09-25T20:05:12.11Z","updated_at":"2026-09-25T20:05:12.11Z","additional_underwriting_data":{"refund_policy":"MERCHANDISE_EXCHANGE_ONLY","credit_check_ip_address":"42.1.1.112","card_volume_distribution":{"card_present_percentage":30,"ecommerce_percentage":60,"mail_order_telephone_order_percentage":10},"average_card_transfer_amount":200000,"merchant_agreement_accepted":true,"merchant_agreement_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)","annual_card_volume":12000000,"merchant_agreement_ip_address":"42.1.1.113","credit_check_allowed":true,"business_description":"Business offering video editing services.","credit_check_user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10_14_6)","volume_distribution_by_business_type":{"business_to_business_volume_percentage":100,"business_to_consumer_volume_percentage":0,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0},"credit_check_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_timestamp":"2021-04-28T16:42:55Z"},"application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":1000000,"amex_mid":null,"annual_card_volume":12000000,"business_address":{"line1":"456 Elm Avenue","line2":null,"city":"Vancouver","region":"BC","postal_code":"V6B 2L2","country":"CAN"},"business_name":"Video Editing Services","business_phone":"+1 (416) 555-7890","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Video Services","discover_mid":null,"dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Video Editing Services","email":"info@video-editing-services.com","first_name":"Jerry","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Dunhill","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"line1":"987 Milo Street","line2":null,"city":"Vancouver","region":"BC","postal_code":"V5K 1Z5","country":"CAN"},"phone":"14158885080","principal_percentage_ownership":50,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.video-editing-services.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Seller (CAN)","summary":"Seller (CAN)","id":"paths/~1identities/post/responses/201/content/application~1json/examples/Seller (CAN)"},"paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Business)":{"value":{"id":"IDo2fLkwALWQoMbFntPB2iMi","created_at":"2026-09-25T20:05:11.22Z","updated_at":"2026-09-25T20:05:11.22Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":{"line1":"7890 Oak Drive","line2":"Suite 101","city":"Smalltown","region":"TX","postal_code":"75432","country":"USA"},"business_name":"Blue Horizon Technologies","business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":"B.H. Technologies","email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT"],"tags":{},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Recipient (Business)","summary":"Recipient (Business)","id":"paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Business)"},"paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Personal)":{"value":{"id":"IDwg9vTS2bNi12SxhScaUTui","created_at":"2026-09-25T20:05:11.66Z","updated_at":"2026-09-25T20:05:11.66Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"789 Oak Drive","line2":null,"city":"Springfield","region":"IL","postal_code":"62704","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Recipient (Personal)","summary":"Recipient (Personal)","id":"paths/~1identities/post/responses/201/content/application~1json/examples/Recipient (Personal)"},"paths/~1identities/post/responses/201/content/application~1json/examples/Buyer":{"value":{"id":"IDm1QmqySG8YQUth47dj2sV5","created_at":"2026-09-25T20:05:10.29Z","updated_at":"2026-09-25T20:05:10.29Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":"johnsmithbuyer@gmail.com","first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Smith","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":"7147148784","principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["BUYER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Buyer","summary":"Buyer","id":"paths/~1identities/post/responses/201/content/application~1json/examples/Buyer"},"paths/~1identities/post/responses/201/content/application~1json/examples/Buyer - Blank":{"value":{"id":"ID8CKX7vwrDDrMNc7D1Cg8mb","created_at":"2026-09-25T20:05:10.69Z","updated_at":"2026-09-25T20:05:10.69Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":null,"has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":null,"max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":null,"line2":null,"city":null,"region":null,"postal_code":null,"country":null},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["BUYER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Buyer - Blank","summary":"Buyer - Blank","id":"paths/~1identities/post/responses/201/content/application~1json/examples/Buyer - Blank"},"paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Personal)":{"value":{"id":"ID6GEE71G68hL1aQA3qyDkDv","created_at":"2026-09-25T20:05:13.82Z","updated_at":"2026-09-25T20:05:13.82Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":"Michael","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Johnson","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"789 Oak Drive","line2":null,"city":"Springfield","region":"IL","postal_code":"62704","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT","SENDER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Sender & Recipient (Personal)","summary":"Sender & Recipient (Personal)","id":"paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Personal)"},"paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Business)":{"value":{"id":"IDsNLvbDXJmsBoZ1X5VtbA48","created_at":"2026-09-25T20:05:13.35Z","updated_at":"2026-09-25T20:05:13.35Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":{"line1":"7890 Oak Drive","line2":"Suite 101","city":"Smalltown","region":"TX","postal_code":"75432","country":"USA"},"business_name":"Blue Horizon Technologies","business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":"B.H. Technologies","email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT","SENDER"],"tags":{},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Sender & Recipient (Business)","summary":"Sender & Recipient (Business)","id":"paths/~1identities/post/responses/201/content/application~1json/examples/Sender & Recipient (Business)"},"paths/~1identities/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1identities/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1identities/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1identities/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1identities/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1identities/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1identities/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1identities/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1identities/get/responses/200/content/application~1json/examples/List of Identities":{"value":{"_embedded":{"identities":[{"id":"ID2TjHWTPQEEMy9BnrygVEUF","created_at":"2026-09-30T00:03:41.72Z","updated_at":"2026-09-30T00:03:41.72Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":{"day":13,"month":4,"year":1985},"doing_business_as":null,"email":"alex.smith@finix.com","first_name":"Alex","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Smith","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"4848 84th St","line2":null,"city":"Bellevue","region":"WA","postal_code":"98032","country":"USA"},"phone":"+14048349343","principal_percentage_ownership":25,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CFO","url":null},"identity_roles":["BENEFICIAL_OWNER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/disputes"}}},{"id":"IDkkcpWZC4BH632gbtcvB52h","created_at":"2026-09-30T00:03:41.46Z","updated_at":"2026-09-30T00:03:41.46Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":100000,"amex_mid":null,"annual_card_volume":1000000,"business_address":{"line1":"123 Bellevue Way","line2":null,"city":"Bellevue","region":"WA","postal_code":"98039","country":"USA"},"business_name":"Finix Flowers","business_phone":"+14048349343","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"CORPORATION","default_statement_descriptor":"DEMOCOMPANY","discover_mid":null,"dob":{"day":13,"month":4,"year":1982},"doing_business_as":"Finix Flowers","email":"john.smith@finix.com","first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":{"day":9,"month":3,"year":2018},"last_name":"Smith","max_transaction_amount":100000,"mcc":"6012","ownership_type":"PRIVATE","personal_address":{"line1":"123 Boren Ave","line2":null,"city":"Seattle","region":"WA","postal_code":"98040","country":"USA"},"phone":"+14048349343","principal_percentage_ownership":75,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.finix.com"},"identity_roles":["SELLER"],"tags":{},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/disputes"}}},{"id":"IDq9KcL6ER6oe5kUw9vk1QzK","created_at":"2026-09-30T00:02:20.85Z","updated_at":"2026-09-30T00:02:20.85Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":1000000,"amex_mid":null,"annual_card_volume":12000000,"business_address":{"line1":"741 Douglass St","line2":"Apartment 8","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"business_name":"Finix Flowers","business_phone":"+1 (408) 756-4497","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Finix Flowers","discover_mid":null,"dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Finix Flowers","email":"user@example.org","first_name":"John","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Smith","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":"14158885080","principal_percentage_ownership":50,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.finix.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/disputes"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/identities?limit=3&after_cursor=IDq9KcL6ER6oe5kUw9vk1QzK"}},"page":{"limit":3,"next_cursor":"IDq9KcL6ER6oe5kUw9vk1QzK"}},"key":"List of Identities","summary":"List of Identities","id":"paths/~1identities/get/responses/200/content/application~1json/examples/List of Identities"},"paths/~1identities/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1identities/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1identities/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1identities/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1identities/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1identities/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1identities/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1identities/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (USA)":{"value":{"id":"IDfC3Z9xVrniLsE6Hk4Zqhjv","created_at":"2026-09-30T00:02:15.54Z","updated_at":"2026-09-30T00:02:15.54Z","additional_underwriting_data":{"refund_policy":"MERCHANDISE_EXCHANGE_ONLY","credit_check_ip_address":"42.1.1.112","card_volume_distribution":{"card_present_percentage":30,"ecommerce_percentage":60,"mail_order_telephone_order_percentage":10},"average_ach_transfer_amount":200000,"average_card_transfer_amount":200000,"merchant_agreement_accepted":true,"merchant_agreement_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)","annual_card_volume":12000000,"merchant_agreement_ip_address":"42.1.1.113","annual_ach_volume":200000,"credit_check_allowed":true,"business_description":"SB3 vegan cafe","credit_check_user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10_14_6)","volume_distribution_by_business_type":{"business_to_business_volume_percentage":100,"business_to_consumer_volume_percentage":0,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0},"credit_check_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_timestamp":"2021-04-28T16:42:55Z"},"application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":1000000,"amex_mid":null,"annual_card_volume":12000000,"business_address":{"line1":"741 Douglass St","line2":"Apartment 8","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"business_name":"Finix Flowers","business_phone":"+1 (408) 756-4497","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Finix Flowers","discover_mid":null,"dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Finix Flowers","email":"user@example.org","first_name":"John","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Smith","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":"14158885080","principal_percentage_ownership":50,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.finix.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Seller (USA)","summary":"Seller (USA)","id":"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (USA)"},"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (CAN)":{"value":{"id":"IDheUNDYiYUNnR2CMCjYJdyK","created_at":"2026-09-25T20:05:12.11Z","updated_at":"2026-09-25T20:05:12.11Z","additional_underwriting_data":{"refund_policy":"MERCHANDISE_EXCHANGE_ONLY","credit_check_ip_address":"42.1.1.112","card_volume_distribution":{"card_present_percentage":30,"ecommerce_percentage":60,"mail_order_telephone_order_percentage":10},"average_card_transfer_amount":200000,"merchant_agreement_accepted":true,"merchant_agreement_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)","annual_card_volume":12000000,"merchant_agreement_ip_address":"42.1.1.113","credit_check_allowed":true,"business_description":"Business offering video editing services.","credit_check_user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10_14_6)","volume_distribution_by_business_type":{"business_to_business_volume_percentage":100,"business_to_consumer_volume_percentage":0,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0},"credit_check_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_timestamp":"2021-04-28T16:42:55Z"},"application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":1000000,"amex_mid":null,"annual_card_volume":12000000,"business_address":{"line1":"456 Elm Avenue","line2":null,"city":"Vancouver","region":"BC","postal_code":"V6B 2L2","country":"CAN"},"business_name":"Video Editing Services","business_phone":"+1 (416) 555-7890","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Video Services","discover_mid":null,"dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Video Editing Services","email":"info@video-editing-services.com","first_name":"Jerry","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Dunhill","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"line1":"987 Milo Street","line2":null,"city":"Vancouver","region":"BC","postal_code":"V5K 1Z5","country":"CAN"},"phone":"14158885080","principal_percentage_ownership":50,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.video-editing-services.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Seller (CAN)","summary":"Seller (CAN)","id":"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Seller (CAN)"},"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Business)":{"value":{"id":"IDo2fLkwALWQoMbFntPB2iMi","created_at":"2026-09-25T20:05:11.22Z","updated_at":"2026-09-25T20:05:11.22Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":{"line1":"7890 Oak Drive","line2":"Suite 101","city":"Smalltown","region":"TX","postal_code":"75432","country":"USA"},"business_name":"Blue Horizon Technologies","business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":"B.H. Technologies","email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT"],"tags":{},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Recipient (Business)","summary":"Recipient (Business)","id":"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Business)"},"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Personal)":{"value":{"id":"IDwg9vTS2bNi12SxhScaUTui","created_at":"2026-09-25T20:05:11.66Z","updated_at":"2026-09-25T20:05:11.66Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"789 Oak Drive","line2":null,"city":"Springfield","region":"IL","postal_code":"62704","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Recipient (Personal)","summary":"Recipient (Personal)","id":"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Recipient (Personal)"},"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer":{"value":{"id":"IDm1QmqySG8YQUth47dj2sV5","created_at":"2026-09-25T20:05:10.29Z","updated_at":"2026-09-25T20:05:10.29Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":"johnsmithbuyer@gmail.com","first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Smith","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":"7147148784","principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["BUYER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Buyer","summary":"Buyer","id":"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer"},"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer - Blank":{"value":{"id":"ID8CKX7vwrDDrMNc7D1Cg8mb","created_at":"2026-09-25T20:05:10.69Z","updated_at":"2026-09-25T20:05:10.69Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":null,"has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":null,"max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":null,"line2":null,"city":null,"region":null,"postal_code":null,"country":null},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["BUYER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Buyer - Blank","summary":"Buyer - Blank","id":"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Buyer - Blank"},"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Personal)":{"value":{"id":"ID6GEE71G68hL1aQA3qyDkDv","created_at":"2026-09-25T20:05:13.82Z","updated_at":"2026-09-25T20:05:13.82Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":"Michael","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Johnson","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"789 Oak Drive","line2":null,"city":"Springfield","region":"IL","postal_code":"62704","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT","SENDER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Sender & Recipient (Personal)","summary":"Sender & Recipient (Personal)","id":"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Personal)"},"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Business)":{"value":{"id":"IDsNLvbDXJmsBoZ1X5VtbA48","created_at":"2026-09-25T20:05:13.35Z","updated_at":"2026-09-25T20:05:13.35Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":{"line1":"7890 Oak Drive","line2":"Suite 101","city":"Smalltown","region":"TX","postal_code":"75432","country":"USA"},"business_name":"Blue Horizon Technologies","business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":"B.H. Technologies","email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT","SENDER"],"tags":{},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Sender & Recipient (Business)","summary":"Sender & Recipient (Business)","id":"paths/~1identities~1{identity_id}/get/responses/200/content/application~1json/examples/Sender & Recipient (Business)"},"paths/~1identities~1{identity_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1identities~1{identity_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1identities~1{identity_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1identities~1{identity_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1identities~1{identity_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"IDhC29dXMAkbmr1aBpS91Hpx was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1identities~1{identity_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1identities~1{identity_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1identities~1{identity_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1identities~1{identity_id}/put/requestBody/content/application~1json/examples/Update an Identity":{"value":{"entity":{"email":"user@example.org","first_name":"John","last_name":"Smith","phone":"7145677613"}},"key":"Update an Identity","summary":"Update an Identity","id":"paths/~1identities~1{identity_id}/put/requestBody/content/application~1json/examples/Update an Identity"},"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (USA)":{"value":{"id":"IDfC3Z9xVrniLsE6Hk4Zqhjv","created_at":"2026-09-30T00:02:15.54Z","updated_at":"2026-09-30T00:02:15.54Z","additional_underwriting_data":{"refund_policy":"MERCHANDISE_EXCHANGE_ONLY","credit_check_ip_address":"42.1.1.112","card_volume_distribution":{"card_present_percentage":30,"ecommerce_percentage":60,"mail_order_telephone_order_percentage":10},"average_ach_transfer_amount":200000,"average_card_transfer_amount":200000,"merchant_agreement_accepted":true,"merchant_agreement_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)","annual_card_volume":12000000,"merchant_agreement_ip_address":"42.1.1.113","annual_ach_volume":200000,"credit_check_allowed":true,"business_description":"SB3 vegan cafe","credit_check_user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10_14_6)","volume_distribution_by_business_type":{"business_to_business_volume_percentage":100,"business_to_consumer_volume_percentage":0,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0},"credit_check_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_timestamp":"2021-04-28T16:42:55Z"},"application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":1000000,"amex_mid":null,"annual_card_volume":12000000,"business_address":{"line1":"741 Douglass St","line2":"Apartment 8","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"business_name":"Finix Flowers","business_phone":"+1 (408) 756-4497","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Finix Flowers","discover_mid":null,"dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Finix Flowers","email":"user@example.org","first_name":"John","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Smith","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":"14158885080","principal_percentage_ownership":50,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.finix.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Seller (USA)","summary":"Seller (USA)","id":"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (USA)"},"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (CAN)":{"value":{"id":"IDheUNDYiYUNnR2CMCjYJdyK","created_at":"2026-09-25T20:05:12.11Z","updated_at":"2026-09-25T20:05:12.11Z","additional_underwriting_data":{"refund_policy":"MERCHANDISE_EXCHANGE_ONLY","credit_check_ip_address":"42.1.1.112","card_volume_distribution":{"card_present_percentage":30,"ecommerce_percentage":60,"mail_order_telephone_order_percentage":10},"average_card_transfer_amount":200000,"merchant_agreement_accepted":true,"merchant_agreement_user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6)","annual_card_volume":12000000,"merchant_agreement_ip_address":"42.1.1.113","credit_check_allowed":true,"business_description":"Business offering video editing services.","credit_check_user_agent":"Mozilla 5.0(Macintosh; IntelMac OS X 10_14_6)","volume_distribution_by_business_type":{"business_to_business_volume_percentage":100,"business_to_consumer_volume_percentage":0,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0},"credit_check_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_timestamp":"2021-04-28T16:42:55Z"},"application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":1000000,"amex_mid":null,"annual_card_volume":12000000,"business_address":{"line1":"456 Elm Avenue","line2":null,"city":"Vancouver","region":"BC","postal_code":"V6B 2L2","country":"CAN"},"business_name":"Video Editing Services","business_phone":"+1 (416) 555-7890","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Video Services","discover_mid":null,"dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Video Editing Services","email":"info@video-editing-services.com","first_name":"Jerry","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Dunhill","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"line1":"987 Milo Street","line2":null,"city":"Vancouver","region":"BC","postal_code":"V5K 1Z5","country":"CAN"},"phone":"14158885080","principal_percentage_ownership":50,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.video-editing-services.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDheUNDYiYUNnR2CMCjYJdyK/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Seller (CAN)","summary":"Seller (CAN)","id":"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Seller (CAN)"},"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Business)":{"value":{"id":"IDo2fLkwALWQoMbFntPB2iMi","created_at":"2026-09-25T20:05:11.22Z","updated_at":"2026-09-25T20:05:11.22Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":{"line1":"7890 Oak Drive","line2":"Suite 101","city":"Smalltown","region":"TX","postal_code":"75432","country":"USA"},"business_name":"Blue Horizon Technologies","business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":"B.H. Technologies","email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT"],"tags":{},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDo2fLkwALWQoMbFntPB2iMi/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Recipient (Business)","summary":"Recipient (Business)","id":"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Business)"},"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Personal)":{"value":{"id":"IDwg9vTS2bNi12SxhScaUTui","created_at":"2026-09-25T20:05:11.66Z","updated_at":"2026-09-25T20:05:11.66Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"789 Oak Drive","line2":null,"city":"Springfield","region":"IL","postal_code":"62704","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDwg9vTS2bNi12SxhScaUTui/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Recipient (Personal)","summary":"Recipient (Personal)","id":"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Recipient (Personal)"},"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer":{"value":{"id":"IDm1QmqySG8YQUth47dj2sV5","created_at":"2026-09-25T20:05:10.29Z","updated_at":"2026-09-25T20:05:10.29Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":"johnsmithbuyer@gmail.com","first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Smith","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":"7147148784","principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["BUYER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDm1QmqySG8YQUth47dj2sV5/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Buyer","summary":"Buyer","id":"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer"},"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer - Blank":{"value":{"id":"ID8CKX7vwrDDrMNc7D1Cg8mb","created_at":"2026-09-25T20:05:10.69Z","updated_at":"2026-09-25T20:05:10.69Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":null,"has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":null,"max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":null,"line2":null,"city":null,"region":null,"postal_code":null,"country":null},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["BUYER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/ID8CKX7vwrDDrMNc7D1Cg8mb/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Buyer - Blank","summary":"Buyer - Blank","id":"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Buyer - Blank"},"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Personal)":{"value":{"id":"ID6GEE71G68hL1aQA3qyDkDv","created_at":"2026-09-25T20:05:13.82Z","updated_at":"2026-09-25T20:05:13.82Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":"Michael","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Johnson","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"789 Oak Drive","line2":null,"city":"Springfield","region":"IL","postal_code":"62704","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT","SENDER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/ID6GEE71G68hL1aQA3qyDkDv/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Sender & Recipient (Personal)","summary":"Sender & Recipient (Personal)","id":"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Personal)"},"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Business)":{"value":{"id":"IDsNLvbDXJmsBoZ1X5VtbA48","created_at":"2026-09-25T20:05:13.35Z","updated_at":"2026-09-25T20:05:13.35Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":{"line1":"7890 Oak Drive","line2":"Suite 101","city":"Smalltown","region":"TX","postal_code":"75432","country":"USA"},"business_name":"Blue Horizon Technologies","business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":"B.H. Technologies","email":null,"first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Jeremy","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":null,"principal_percentage_ownership":null,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["RECIPIENT","SENDER"],"tags":{},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDsNLvbDXJmsBoZ1X5VtbA48/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Sender & Recipient (Business)","summary":"Sender & Recipient (Business)","id":"paths/~1identities~1{identity_id}/put/responses/200/content/application~1json/examples/Sender & Recipient (Business)"},"paths/~1identities~1{identity_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1identities~1{identity_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1identities~1{identity_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1identities~1{identity_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1identities~1{identity_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1identities~1{identity_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1identities~1{identity_id}/put/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"IDhC29dXMAkbmr1aBpS91Hpx was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1identities~1{identity_id}/put/responses/404/content/application~1json/examples/NotFound"},"paths/~1identities~1{identity_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1identities~1{identity_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1identities~1{identity_id}~1associated_identities/post/requestBody/content/application~1json/examples/Associated Identity":{"value":{"entity":{"dob":{"day":1,"month":1,"year":2013},"email":"john.smith@company1.com","first_name":"John","last_name":"Smith","personal_address":{"city":"San Francisco","country":"USA","line1":"123 Main Street","postal_code":"90650","region":"CA"},"phone":"14158885080","principal_percentage_ownership":25,"tax_id":"123456789","title":"Founder"}},"key":"Associated Identity","summary":"Associated Identity","id":"paths/~1identities~1{identity_id}~1associated_identities/post/requestBody/content/application~1json/examples/Associated Identity"},"paths/~1identities~1{identity_id}~1associated_identities/post/responses/201/content/application~1json/examples/Associated Identity":{"value":{"id":"IDqtCHPKqe1puxTcTg2EzKa9","created_at":"2026-09-25T20:05:09.98Z","updated_at":"2026-09-25T20:05:09.98Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":null,"doing_business_as":null,"email":null,"first_name":null,"has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":null,"max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":null,"phone":null,"principal_percentage_ownership":25,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":null,"tax_id_provided":false,"title":null,"url":null},"identity_roles":["BENEFICIAL_OWNER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDqtCHPKqe1puxTcTg2EzKa9/disputes"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Associated Identity","summary":"Associated Identity","id":"paths/~1identities~1{identity_id}~1associated_identities/post/responses/201/content/application~1json/examples/Associated Identity"},"paths/~1identities~1{identity_id}~1associated_identities/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1identities~1{identity_id}~1associated_identities/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1identities~1{identity_id}~1associated_identities/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1identities~1{identity_id}~1associated_identities/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1identities~1{identity_id}~1associated_identities/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1identities~1{identity_id}~1associated_identities/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1identities~1{identity_id}~1associated_identities/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1identities~1{identity_id}~1associated_identities/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1identities~1{identity_id}~1associated_identities/get/responses/200/content/application~1json/examples/List of Identities":{"value":{"_embedded":{"identities":[{"id":"ID2TjHWTPQEEMy9BnrygVEUF","created_at":"2026-09-30T00:03:41.72Z","updated_at":"2026-09-30T00:03:41.72Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":0,"amex_mid":null,"annual_card_volume":0,"business_address":null,"business_name":null,"business_phone":null,"business_tax_id_fingerprint":null,"business_tax_id_provided":false,"business_type":null,"default_statement_descriptor":null,"discover_mid":null,"dob":{"day":13,"month":4,"year":1985},"doing_business_as":null,"email":"alex.smith@finix.com","first_name":"Alex","has_accepted_credit_cards_previously":false,"incorporation_date":null,"last_name":"Smith","max_transaction_amount":0,"mcc":null,"ownership_type":null,"personal_address":{"line1":"4848 84th St","line2":null,"city":"Bellevue","region":"WA","postal_code":"98032","country":"USA"},"phone":"+14048349343","principal_percentage_ownership":25,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CFO","url":null},"identity_roles":["BENEFICIAL_OWNER"],"tags":{},"type":"PERSONAL","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/ID2TjHWTPQEEMy9BnrygVEUF/disputes"}}},{"id":"IDkkcpWZC4BH632gbtcvB52h","created_at":"2026-09-30T00:03:41.46Z","updated_at":"2026-09-30T00:03:41.46Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":100000,"amex_mid":null,"annual_card_volume":1000000,"business_address":{"line1":"123 Bellevue Way","line2":null,"city":"Bellevue","region":"WA","postal_code":"98039","country":"USA"},"business_name":"Finix Flowers","business_phone":"+14048349343","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"CORPORATION","default_statement_descriptor":"DEMOCOMPANY","discover_mid":null,"dob":{"day":13,"month":4,"year":1982},"doing_business_as":"Finix Flowers","email":"john.smith@finix.com","first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":{"day":9,"month":3,"year":2018},"last_name":"Smith","max_transaction_amount":100000,"mcc":"6012","ownership_type":"PRIVATE","personal_address":{"line1":"123 Boren Ave","line2":null,"city":"Seattle","region":"WA","postal_code":"98040","country":"USA"},"phone":"+14048349343","principal_percentage_ownership":75,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.finix.com"},"identity_roles":["SELLER"],"tags":{},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h/disputes"}}},{"id":"IDq9KcL6ER6oe5kUw9vk1QzK","created_at":"2026-09-30T00:02:20.85Z","updated_at":"2026-09-30T00:02:20.85Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","entity":{"ach_max_transaction_amount":1000000,"amex_mid":null,"annual_card_volume":12000000,"business_address":{"line1":"741 Douglass St","line2":"Apartment 8","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"business_name":"Finix Flowers","business_phone":"+1 (408) 756-4497","business_tax_id_fingerprint":"business_tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","business_tax_id_provided":true,"business_type":"INDIVIDUAL_SOLE_PROPRIETORSHIP","default_statement_descriptor":"Finix Flowers","discover_mid":null,"dob":{"day":27,"month":6,"year":1978},"doing_business_as":"Finix Flowers","email":"user@example.org","first_name":"John","has_accepted_credit_cards_previously":true,"incorporation_date":{"day":27,"month":6,"year":1978},"last_name":"Smith","max_transaction_amount":1000000,"mcc":"4900","ownership_type":"PRIVATE","personal_address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"phone":"14158885080","principal_percentage_ownership":50,"short_business_name":null,"tax_authority":null,"tax_id_fingerprint":"tax_fpr_tukGF2uSeRPcXqS2B1ngPQ","tax_id_provided":true,"title":"CEO","url":"https://www.finix.com"},"identity_roles":["SELLER"],"tags":{"Studio Rating":"4.7"},"type":"BUSINESS","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verifications":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/verifications"},"merchants":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/merchants"},"settlements":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/settlements"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/transfers"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/payment_instruments"},"associated_identities":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/associated_identities"},"disputes":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK/disputes"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/identities?limit=3&after_cursor=IDq9KcL6ER6oe5kUw9vk1QzK"}},"page":{"limit":3,"next_cursor":"IDq9KcL6ER6oe5kUw9vk1QzK"}},"key":"List of Identities","summary":"List of Identities","id":"paths/~1identities~1{identity_id}~1associated_identities/get/responses/200/content/application~1json/examples/List of Identities"},"paths/~1identities~1{identity_id}~1associated_identities/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1identities~1{identity_id}~1associated_identities/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1identities~1{identity_id}~1associated_identities/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1identities~1{identity_id}~1associated_identities/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1identities~1{identity_id}~1associated_identities/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1identities~1{identity_id}~1associated_identities/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1identities~1{identity_id}~1associated_identities/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/associated_identities"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1identities~1{identity_id}~1associated_identities/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1identities~1{identity_id}~1merchants/get/responses/200/content/application~1json/examples/List of Merchants":{"value":{"_embedded":{"merchants":[{"id":"MU28NZ49FWpXPM4UkMEWATEF","created_at":"2026-09-25T20:06:54.59Z","updated_at":"2026-09-25T20:07:03.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-09-25T20:07:03.21Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDm7cEEr5stCd7vUYRHKDsqs","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPbywVLQovHYvrMmvAE9NotL","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":"FNX8bUT5k3N76YvsxEdDvP4tM","onboarding_state":"APPROVED","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNX8bUT5k3N76YvsxEdDvP4tM","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{"order_id":"ORD-123"},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIhNG3yx7gNN8ikjCp9huTVs","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MU28NZ49FWpXPM4UkMEWATEF"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDm7cEEr5stCd7vUYRHKDsqs"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MU28NZ49FWpXPM4UkMEWATEF/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPbywVLQovHYvrMmvAE9NotL"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIhNG3yx7gNN8ikjCp9huTVs"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"MUeGAgVmwcHD4jNHFmAxHTrm","created_at":"2026-09-25T20:06:52.84Z","updated_at":"2026-09-25T20:07:02.93Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-09-25T20:07:02.95Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDpxyDdo9RgJpsmfM45vVPJ6","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPrwPrsqCNJhJX9L57zhiWiX","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":"FNXuhxYrydhUj95XtZ2wxNfrV","onboarding_state":"APPROVED","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXuhxYrydhUj95XtZ2wxNfrV","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIkbyj4r6ZvE5nGWfBNgUnuC","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUeGAgVmwcHD4jNHFmAxHTrm"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDpxyDdo9RgJpsmfM45vVPJ6"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUeGAgVmwcHD4jNHFmAxHTrm/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPrwPrsqCNJhJX9L57zhiWiX"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIkbyj4r6ZvE5nGWfBNgUnuC"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"MU4YKW5VuamZriGSCBKj9cyZ","created_at":"2026-09-25T19:47:40.47Z","updated_at":"2026-09-25T19:48:03.36Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-09-25T19:48:03.39Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDdgLJPevfKoHk4KP3Yg2XsD","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":true,"mcc":"6012","merchant_name":"Finix Flowers","merchant_profile":"MPhYuYKuEpejyZ6kacdv61PB","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":"FNX8TW96Cd576zdZuLidxpMfL","onboarding_state":"APPROVED","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNX8TW96Cd576zdZuLidxpMfL","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIu8nxwAz91tt9cFJ7wDVz5x","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MU4YKW5VuamZriGSCBKj9cyZ"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDdgLJPevfKoHk4KP3Yg2XsD"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MU4YKW5VuamZriGSCBKj9cyZ/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPhYuYKuEpejyZ6kacdv61PB"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIu8nxwAz91tt9cFJ7wDVz5x"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/merchants?limit=3&after_cursor=MU4YKW5VuamZriGSCBKj9cyZ"}},"page":{"limit":3,"next_cursor":"MU4YKW5VuamZriGSCBKj9cyZ"}},"key":"List of Merchants","summary":"List of Merchants","id":"paths/~1identities~1{identity_id}~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"},"paths/~1identities~1{identity_id}~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/merchants"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1identities~1{identity_id}~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1identities~1{identity_id}~1merchants/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/merchants"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1identities~1{identity_id}~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1identities~1{identity_id}~1merchants/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"IDhC29dXMAkbmr1aBpS91Hpx was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/merchants"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1identities~1{identity_id}~1merchants/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1identities~1{identity_id}~1merchants/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/merchants"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1identities~1{identity_id}~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Minimal Fields":{"value":{"processor":"DUMMY_V1"},"key":"Merchant - Minimal Fields","summary":"Merchant - Minimal Fields","id":"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Minimal Fields"},"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - All Fields":{"value":{"default_partial_authorization_enabled":true,"processor":"DUMMY_V1","refunds_disabled":false,"tags":{"order_id":"ORD-123"}},"key":"Merchant - All Fields","summary":"Merchant - All Fields","id":"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - All Fields"},"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Card Present Enabled":{"value":{"processor":"DUMMY_V1"},"key":"Merchant - Card Present Enabled","summary":"Merchant - Card Present Enabled","id":"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Card Present Enabled"},"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Default Partial Authorization Enabled":{"value":{"default_partial_authorization_enabled":true,"processor":"DUMMY_V1"},"key":"Merchant - Default Partial Authorization Enabled","summary":"Merchant - Default Partial Authorization Enabled","id":"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Default Partial Authorization Enabled"},"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Loan Repayment Enabled":{"value":{"loan_repayment":true,"processor":"DUMMY_V1"},"key":"Merchant - Loan Repayment Enabled","summary":"Merchant - Loan Repayment Enabled","id":"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Loan Repayment Enabled"},"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Refunds Disabled":{"value":{"processor":"DUMMY_V1","refunds_disabled":true},"key":"Merchant - Refunds Disabled","summary":"Merchant - Refunds Disabled","id":"paths/~1identities~1{identity_id}~1merchants/post/requestBody/content/application~1json/examples/Merchant - Refunds Disabled"},"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Minimal Fields":{"value":{"id":"MU3CTeJT1MMhwaGZabCo2xwK","created_at":"2026-09-30T00:02:16.89Z","updated_at":"2026-09-30T00:02:16.89Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":null,"gateway":null,"gross_settlement_enabled":false,"identity":"IDfC3Z9xVrniLsE6Hk4Zqhjv","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPh7HkSopbp5wFnTgWNQujDx","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":null,"onboarding_state":"PROVISIONING","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIw6VyyzVBjdoabt98e4Nrj2","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MU3CTeJT1MMhwaGZabCo2xwK"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDfC3Z9xVrniLsE6Hk4Zqhjv"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MU3CTeJT1MMhwaGZabCo2xwK/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPh7HkSopbp5wFnTgWNQujDx"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIw6VyyzVBjdoabt98e4Nrj2"}}},"key":"Merchant - Minimal Fields","summary":"Merchant - Minimal Fields","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Minimal Fields"},"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - All Fields":{"value":{"id":"MU9hcmnx5cWZUmRFKRqHnKc8","created_at":"2026-09-30T00:02:18.62Z","updated_at":"2026-09-30T00:02:18.62Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":null,"gateway":null,"gross_settlement_enabled":false,"identity":"IDxmXmkWTmyipx5DdwbYFWP2","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPtAYYmX7of1MYkqKH9GBYAm","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":null,"onboarding_state":"PROVISIONING","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{"order_id":"ORD-123"},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIpfHm3CLqD77hCUqCKeiF","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MU9hcmnx5cWZUmRFKRqHnKc8"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDxmXmkWTmyipx5DdwbYFWP2"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MU9hcmnx5cWZUmRFKRqHnKc8/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPtAYYmX7of1MYkqKH9GBYAm"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIpfHm3CLqD77hCUqCKeiF"}}},"key":"Merchant - All Fields","summary":"Merchant - All Fields","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - All Fields"},"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Card Present Enabled":{"value":{"id":"MUmFY9PWbqJPGtQEN7RXdFAb","created_at":"2026-09-28T20:29:42.66Z","updated_at":"2026-09-28T20:29:42.66Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":null,"gateway":null,"gross_settlement_enabled":false,"identity":"IDvEVPqD9rnfLCAGnLJphyGT","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP8snQL9LvzjJz5Fr67ndDpZ","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":null,"onboarding_state":"PROVISIONING","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VI4YSfJVZRnxAJPM3wRXSbfZ","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUmFY9PWbqJPGtQEN7RXdFAb"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvEVPqD9rnfLCAGnLJphyGT"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUmFY9PWbqJPGtQEN7RXdFAb/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP8snQL9LvzjJz5Fr67ndDpZ"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VI4YSfJVZRnxAJPM3wRXSbfZ"}}},"key":"Merchant - Card Present Enabled","summary":"Merchant - Card Present Enabled","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Card Present Enabled"},"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Default Partial Authorization Enabled":{"value":{"id":"MUfgUw9uKkWmxdcvBDU6MdKv","created_at":"2026-09-30T00:02:21.87Z","updated_at":"2026-09-30T00:02:21.87Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":null,"gateway":null,"gross_settlement_enabled":false,"identity":"IDq9KcL6ER6oe5kUw9vk1QzK","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPn265WFK8EHtRfeAjDtp8SD","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":null,"onboarding_state":"PROVISIONING","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VI92t6ZhDRybhbZpW6v4ADVg","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUfgUw9uKkWmxdcvBDU6MdKv"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDq9KcL6ER6oe5kUw9vk1QzK"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUfgUw9uKkWmxdcvBDU6MdKv/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPn265WFK8EHtRfeAjDtp8SD"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VI92t6ZhDRybhbZpW6v4ADVg"}}},"key":"Merchant - Default Partial Authorization Enabled","summary":"Merchant - Default Partial Authorization Enabled","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Default Partial Authorization Enabled"},"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Loan Repayment Enabled":{"value":{"id":"MUi8t3vZZszuYVYp6xZd3xXM","created_at":"2026-09-30T00:03:47.11Z","updated_at":"2026-09-30T00:03:47.11Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":null,"gateway":null,"gross_settlement_enabled":false,"identity":"IDkkcpWZC4BH632gbtcvB52h","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":true,"mcc":"6012","merchant_name":"Finix Flowers","merchant_profile":"MPvtyTjaee7XZ6UgaYvDxhoo","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":null,"onboarding_state":"PROVISIONING","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIh7waQM3RYJUGAbY1vsCis2","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUi8t3vZZszuYVYp6xZd3xXM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDkkcpWZC4BH632gbtcvB52h"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUi8t3vZZszuYVYp6xZd3xXM/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPvtyTjaee7XZ6UgaYvDxhoo"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIh7waQM3RYJUGAbY1vsCis2"}}},"key":"Merchant - Loan Repayment Enabled","summary":"Merchant - Loan Repayment Enabled","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Loan Repayment Enabled"},"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Refunds Disabled":{"value":{"id":"MUpzJZYa8bT46wmA7XaBX4L9","created_at":"2026-09-30T00:02:20.30Z","updated_at":"2026-09-30T00:02:20.30Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":null,"gateway":null,"gross_settlement_enabled":false,"identity":"IDkemSfUrLX1tkZpgQWMJXZs","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPjZZwDiQj6SVHuJiXBrFyfN","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":null,"onboarding_state":"PROVISIONING","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":true,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VI2R9GbrxUTKDn6Tn5aa1h32","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUpzJZYa8bT46wmA7XaBX4L9"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDkemSfUrLX1tkZpgQWMJXZs"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUpzJZYa8bT46wmA7XaBX4L9/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPjZZwDiQj6SVHuJiXBrFyfN"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VI2R9GbrxUTKDn6Tn5aa1h32"}}},"key":"Merchant - Refunds Disabled","summary":"Merchant - Refunds Disabled","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/201/content/application~1json/examples/Merchant - Refunds Disabled"},"paths/~1identities~1{identity_id}~1merchants/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/merchants"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1identities~1{identity_id}~1merchants/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/merchants"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1identities~1{identity_id}~1merchants/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/merchants"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1identities~1{identity_id}~1merchants/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/identities/IDhC29dXMAkbmr1aBpS91Hpx/merchants"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1identities~1{identity_id}~1merchants/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1merchants/get/responses/200/content/application~1json/examples/List of Merchants":{"value":{"_embedded":{"merchants":[{"id":"MU28NZ49FWpXPM4UkMEWATEF","created_at":"2026-09-25T20:06:54.59Z","updated_at":"2026-09-25T20:07:03.19Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-09-25T20:07:03.21Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDm7cEEr5stCd7vUYRHKDsqs","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPbywVLQovHYvrMmvAE9NotL","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":"FNX8bUT5k3N76YvsxEdDvP4tM","onboarding_state":"APPROVED","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNX8bUT5k3N76YvsxEdDvP4tM","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{"order_id":"ORD-123"},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIhNG3yx7gNN8ikjCp9huTVs","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MU28NZ49FWpXPM4UkMEWATEF"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDm7cEEr5stCd7vUYRHKDsqs"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MU28NZ49FWpXPM4UkMEWATEF/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPbywVLQovHYvrMmvAE9NotL"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIhNG3yx7gNN8ikjCp9huTVs"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"MUeGAgVmwcHD4jNHFmAxHTrm","created_at":"2026-09-25T20:06:52.84Z","updated_at":"2026-09-25T20:07:02.93Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-09-25T20:07:02.95Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDpxyDdo9RgJpsmfM45vVPJ6","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPrwPrsqCNJhJX9L57zhiWiX","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":"FNXuhxYrydhUj95XtZ2wxNfrV","onboarding_state":"APPROVED","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXuhxYrydhUj95XtZ2wxNfrV","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIkbyj4r6ZvE5nGWfBNgUnuC","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUeGAgVmwcHD4jNHFmAxHTrm"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDpxyDdo9RgJpsmfM45vVPJ6"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUeGAgVmwcHD4jNHFmAxHTrm/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPrwPrsqCNJhJX9L57zhiWiX"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIkbyj4r6ZvE5nGWfBNgUnuC"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"MU4YKW5VuamZriGSCBKj9cyZ","created_at":"2026-09-25T19:47:40.47Z","updated_at":"2026-09-25T19:48:03.36Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-09-25T19:48:03.39Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDdgLJPevfKoHk4KP3Yg2XsD","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":true,"mcc":"6012","merchant_name":"Finix Flowers","merchant_profile":"MPhYuYKuEpejyZ6kacdv61PB","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":"FNX8TW96Cd576zdZuLidxpMfL","onboarding_state":"APPROVED","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNX8TW96Cd576zdZuLidxpMfL","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIu8nxwAz91tt9cFJ7wDVz5x","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MU4YKW5VuamZriGSCBKj9cyZ"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDdgLJPevfKoHk4KP3Yg2XsD"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MU4YKW5VuamZriGSCBKj9cyZ/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPhYuYKuEpejyZ6kacdv61PB"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIu8nxwAz91tt9cFJ7wDVz5x"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/merchants?limit=3&after_cursor=MU4YKW5VuamZriGSCBKj9cyZ"}},"page":{"limit":3,"next_cursor":"MU4YKW5VuamZriGSCBKj9cyZ"}},"key":"List of Merchants","summary":"List of Merchants","id":"paths/~1merchants/get/responses/200/content/application~1json/examples/List of Merchants"},"paths/~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1merchants/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1merchants/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1merchants/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1merchants/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1merchants/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1merchants/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1merchants/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1merchants~1{merchant_id}/get/responses/200/content/application~1json/examples/Merchant":{"value":{"id":"MU9hcmnx5cWZUmRFKRqHnKc8","created_at":"2026-09-30T00:02:18.62Z","updated_at":"2026-09-30T00:02:18.62Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":false,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":null,"gateway":null,"gross_settlement_enabled":false,"identity":"IDxmXmkWTmyipx5DdwbYFWP2","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":false,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MPtAYYmX7of1MYkqKH9GBYAm","microdeposit_verification_required_buyer":true,"microdeposit_verification_required_sender":false,"mid":null,"onboarding_state":"PROVISIONING","pending_refunds_strategy":"SAME_DAY_ADJUSTMENT","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{"order_id":"ORD-123"},"termination_details":null,"unreferenced_refund_card_present_enabled":true,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIpfHm3CLqD77hCUqCKeiF","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MU9hcmnx5cWZUmRFKRqHnKc8"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDxmXmkWTmyipx5DdwbYFWP2"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MU9hcmnx5cWZUmRFKRqHnKc8/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPtAYYmX7of1MYkqKH9GBYAm"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIpfHm3CLqD77hCUqCKeiF"}}},"key":"Merchant","summary":"Merchant","id":"paths/~1merchants~1{merchant_id}/get/responses/200/content/application~1json/examples/Merchant"},"paths/~1merchants~1{merchant_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1merchants~1{merchant_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1merchants~1{merchant_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1merchants~1{merchant_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1merchants~1{merchant_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"MUwfZPNW3r4EqLMzwgr6txw4 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1merchants~1{merchant_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1merchants~1{merchant_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1merchants~1{merchant_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Processing":{"value":{"processing_enabled":false},"key":"Disable Processing","summary":"Disable Processing","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Processing"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Settlements":{"value":{"settlement_enabled":false},"key":"Disable Settlements","summary":"Disable Settlements","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Disable Settlements"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Buyer Charges":{"value":{"convenience_charges_enabled":true},"key":"Enable Buyer Charges","summary":"Enable Buyer Charges","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Buyer Charges"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Level 2~13 Processing":{"value":{"level_two_level_three_data_enabled":true},"key":"Enable Level 2/3 Processing","summary":"Enable Level 2/3 Processing","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Level 2~13 Processing"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Loan Repayment":{"value":{"loan_repayment":true},"key":"Enable Loan Repayment","summary":"Enable Loan Repayment","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Loan Repayment"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Partial Authorizations":{"value":{"default_partial_authorization_enabled":true},"key":"Enable Partial Authorizations","summary":"Enable Partial Authorizations","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Partial Authorizations"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull":{"value":{"disbursements_same_day_ach_pull_enabled":true,"disbursements_same_day_ach_push_enabled":true},"key":"Enable Disbursements Same-Day ACH Push & Pull","summary":"Enable Disbursements Same-Day ACH Push & Pull","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Settlement Queue":{"value":{"settlement_queue_mode":"MANUAL"},"key":"Enable Settlement Queue","summary":"Enable Settlement Queue","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Enable Settlement Queue"},"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Terminate Merchant":{"value":{"is_terminated":true,"termination_details":{"description":"Customer canceled","reason":"CHURNED"}},"key":"Terminate Merchant","summary":"Terminate Merchant","id":"paths/~1merchants~1{merchant_id}/put/requestBody/content/application~1json/examples/Terminate Merchant"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Processing":{"value":{"id":"MUiV7ntxfY4eyJxp6E7cZvym","created_at":"2026-04-03T22:05:19.34Z","updated_at":"2026-09-25T20:05:18.11Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-04-03T22:06:04.00Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDa4fdEuy57uLT95prqoBDxx","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":true,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP6pzw61XykboCKVbMhCgYuk","microdeposit_verification_required_buyer":false,"microdeposit_verification_required_sender":false,"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","onboarding_state":"APPROVED","pending_refunds_strategy":"NONE","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"MANUAL","surcharges_enabled":false,"tags":{"key_2":"value_2"},"termination_details":null,"unreferenced_refund_card_present_enabled":false,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIeDkhAdS91Cw4Hu324YR6Te","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDa4fdEuy57uLT95prqoBDxx"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP6pzw61XykboCKVbMhCgYuk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIeDkhAdS91Cw4Hu324YR6Te"}}},"key":"Disable Processing","summary":"Disable Processing","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Processing"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Settlements":{"value":{"id":"MUiV7ntxfY4eyJxp6E7cZvym","created_at":"2026-04-03T22:05:19.34Z","updated_at":"2026-09-25T20:05:18.58Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-04-03T22:06:04.00Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDa4fdEuy57uLT95prqoBDxx","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":true,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP6pzw61XykboCKVbMhCgYuk","microdeposit_verification_required_buyer":false,"microdeposit_verification_required_sender":false,"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","onboarding_state":"APPROVED","pending_refunds_strategy":"NONE","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"MANUAL","surcharges_enabled":false,"tags":{"key_2":"value_2"},"termination_details":null,"unreferenced_refund_card_present_enabled":false,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIeDkhAdS91Cw4Hu324YR6Te","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDa4fdEuy57uLT95prqoBDxx"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP6pzw61XykboCKVbMhCgYuk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIeDkhAdS91Cw4Hu324YR6Te"}}},"key":"Disable Settlements","summary":"Disable Settlements","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Disable Settlements"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Buyer Charges":{"value":{"id":"MUiV7ntxfY4eyJxp6E7cZvym","created_at":"2026-04-03T22:05:19.34Z","updated_at":"2026-09-25T20:05:19.03Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-04-03T22:06:04.00Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDa4fdEuy57uLT95prqoBDxx","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":true,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP6pzw61XykboCKVbMhCgYuk","microdeposit_verification_required_buyer":false,"microdeposit_verification_required_sender":false,"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","onboarding_state":"APPROVED","pending_refunds_strategy":"NONE","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"MANUAL","surcharges_enabled":false,"tags":{"key_2":"value_2"},"termination_details":null,"unreferenced_refund_card_present_enabled":false,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIeDkhAdS91Cw4Hu324YR6Te","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDa4fdEuy57uLT95prqoBDxx"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP6pzw61XykboCKVbMhCgYuk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIeDkhAdS91Cw4Hu324YR6Te"}}},"key":"Enable Buyer Charges","summary":"Enable Buyer Charges","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Buyer Charges"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Level 2~13 Processing":{"value":{"id":"MUiV7ntxfY4eyJxp6E7cZvym","created_at":"2026-04-03T22:05:19.34Z","updated_at":"2026-09-25T20:05:19.51Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-04-03T22:06:04.00Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDa4fdEuy57uLT95prqoBDxx","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":true,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP6pzw61XykboCKVbMhCgYuk","microdeposit_verification_required_buyer":false,"microdeposit_verification_required_sender":false,"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","onboarding_state":"APPROVED","pending_refunds_strategy":"NONE","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"MANUAL","surcharges_enabled":false,"tags":{"key_2":"value_2"},"termination_details":null,"unreferenced_refund_card_present_enabled":false,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIeDkhAdS91Cw4Hu324YR6Te","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDa4fdEuy57uLT95prqoBDxx"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP6pzw61XykboCKVbMhCgYuk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIeDkhAdS91Cw4Hu324YR6Te"}}},"key":"Enable Level 2/3 Processing","summary":"Enable Level 2/3 Processing","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Level 2~13 Processing"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Loan Repayment":{"value":{"id":"MU7noQ1wdgdAeAfymw2rfBMq","created_at":"2024-11-14T22:25:07.80Z","updated_at":"2025-07-18T18:40:12.02Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":false,"disbursements_ach_push_enabled":false,"disbursements_card_pull_enabled":false,"disbursements_card_push_enabled":false,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","gateway":null,"gross_settlement_enabled":false,"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":true,"loan_repayment":true,"mcc":null,"merchant_name":"BrainTree","merchant_profile":"MPrqHHN5y5Up4AGYENnEGvah","mid":"FNXdp4rntUy6oRgNDBARQQZou","onboarding_state":"APPROVED","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXdp4rntUy6oRgNDBARQQZou","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":true,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"UNSET","surcharges_enabled":false,"tags":{"type":"facilitator"},"termination_details":null,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIiq2VoSUWphJvSNCgqrBsaB","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7noQ1wdgdAeAfymw2rfBMq/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MPrqHHN5y5Up4AGYENnEGvah"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIiq2VoSUWphJvSNCgqrBsaB"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Enable Loan Repayment","summary":"Enable Loan Repayment","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Loan Repayment"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Partial Authorizations":{"value":{"id":"MUiV7ntxfY4eyJxp6E7cZvym","created_at":"2026-04-03T22:05:19.34Z","updated_at":"2026-09-25T20:05:19.94Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":true,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-04-03T22:06:04.00Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDa4fdEuy57uLT95prqoBDxx","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":true,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP6pzw61XykboCKVbMhCgYuk","microdeposit_verification_required_buyer":false,"microdeposit_verification_required_sender":false,"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","onboarding_state":"APPROVED","pending_refunds_strategy":"NONE","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"MANUAL","surcharges_enabled":false,"tags":{"key_2":"value_2"},"termination_details":null,"unreferenced_refund_card_present_enabled":false,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIeDkhAdS91Cw4Hu324YR6Te","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDa4fdEuy57uLT95prqoBDxx"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP6pzw61XykboCKVbMhCgYuk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIeDkhAdS91Cw4Hu324YR6Te"}}},"key":"Enable Partial Authorizations","summary":"Enable Partial Authorizations","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Partial Authorizations"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull":{"value":{"id":"MUiV7ntxfY4eyJxp6E7cZvym","created_at":"2026-04-03T22:05:19.34Z","updated_at":"2026-09-25T20:05:20.38Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":true,"disbursements_same_day_ach_push_enabled":true,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-04-03T22:06:04.00Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDa4fdEuy57uLT95prqoBDxx","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":true,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP6pzw61XykboCKVbMhCgYuk","microdeposit_verification_required_buyer":false,"microdeposit_verification_required_sender":false,"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","onboarding_state":"APPROVED","pending_refunds_strategy":"NONE","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"MANUAL","surcharges_enabled":false,"tags":{"key_2":"value_2"},"termination_details":null,"unreferenced_refund_card_present_enabled":false,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIeDkhAdS91Cw4Hu324YR6Te","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDa4fdEuy57uLT95prqoBDxx"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP6pzw61XykboCKVbMhCgYuk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIeDkhAdS91Cw4Hu324YR6Te"}}},"key":"Enable Disbursements Same-Day ACH Push & Pull","summary":"Enable Disbursements Same-Day ACH Push & Pull","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Disbursements Same-Day ACH Push & Pull"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Settlement Queue":{"value":{"id":"MUiV7ntxfY4eyJxp6E7cZvym","created_at":"2026-04-03T22:05:19.34Z","updated_at":"2026-09-25T20:05:20.82Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-04-03T22:06:04.00Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDa4fdEuy57uLT95prqoBDxx","instant_payouts_card_push_enabled":false,"is_terminated":false,"level_two_level_three_data_enabled":true,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP6pzw61XykboCKVbMhCgYuk","microdeposit_verification_required_buyer":false,"microdeposit_verification_required_sender":false,"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","onboarding_state":"APPROVED","pending_refunds_strategy":"NONE","processing_enabled":true,"processor":"DUMMY_V1","processor_details":{"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":false,"rent_surcharges_enabled":false,"settlement_enabled":true,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"MANUAL","surcharges_enabled":false,"tags":{"key_2":"value_2"},"termination_details":null,"unreferenced_refund_card_present_enabled":false,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIeDkhAdS91Cw4Hu324YR6Te","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDa4fdEuy57uLT95prqoBDxx"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP6pzw61XykboCKVbMhCgYuk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIeDkhAdS91Cw4Hu324YR6Te"}}},"key":"Enable Settlement Queue","summary":"Enable Settlement Queue","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Enable Settlement Queue"},"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Terminate Merchant":{"value":{"id":"MUiV7ntxfY4eyJxp6E7cZvym","created_at":"2026-04-03T22:05:19.34Z","updated_at":"2026-09-25T20:05:21.23Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","card_cvv_required":false,"card_expiration_date_required":true,"card_network_details":null,"convenience_charges_enabled":true,"country":"USA","creating_transfer_from_report_enabled":false,"currencies":["USD"],"default_partial_authorization_enabled":false,"disbursements_ach_pull_enabled":true,"disbursements_ach_push_enabled":true,"disbursements_card_pull_enabled":true,"disbursements_card_push_enabled":true,"disbursements_same_day_ach_pull_enabled":false,"disbursements_same_day_ach_push_enabled":false,"fee_ready_to_settle_upon":"PROCESSOR_WINDOW","first_approved_at":"2026-04-03T22:06:04.00Z","gateway":null,"gross_settlement_enabled":false,"identity":"IDa4fdEuy57uLT95prqoBDxx","instant_payouts_card_push_enabled":false,"is_terminated":true,"level_two_level_three_data_enabled":true,"loan_repayment":null,"mcc":"4900","merchant_name":"Finix Flowers","merchant_profile":"MP6pzw61XykboCKVbMhCgYuk","microdeposit_verification_required_buyer":false,"microdeposit_verification_required_sender":false,"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","onboarding_state":"APPROVED","pending_refunds_strategy":"NONE","processing_enabled":false,"processor":"DUMMY_V1","processor_details":{"mid":"FNXwXimxKRxzJ34EX4bAcv6q3","api_key":"secretValue"},"ready_to_settle_upon":"PROCESSOR_WINDOW","ready_to_settle_upon_delay_alignment":"NONE","refunds_disabled":true,"rent_surcharges_enabled":false,"settlement_enabled":false,"settlement_funding_identifier":"UNSET","settlement_queue_mode":"MANUAL","surcharges_enabled":false,"tags":{"key_2":"value_2"},"termination_details":{"terminated_at":"2026-09-25T20:05:21.21Z","reason":"CHURNED","description":"Customer canceled","terminated_by":"PARTNER_USER","terminated_by_user_id":"USfdccsr1Z5iVbXDyYt7hjZZ"},"unreferenced_refund_card_present_enabled":false,"unreferenced_refund_manual_entry_enabled":false,"verification":"VIeDkhAdS91Cw4Hu324YR6Te","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDa4fdEuy57uLT95prqoBDxx"},"verifications":{"href":"https://finix.sandbox-payments-api.com/merchants/MUiV7ntxfY4eyJxp6E7cZvym/verifications"},"merchant_profile":{"href":"https://finix.sandbox-payments-api.com/merchant_profiles/MP6pzw61XykboCKVbMhCgYuk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"verification":{"href":"https://finix.sandbox-payments-api.com/verifications/VIeDkhAdS91Cw4Hu324YR6Te"}}},"key":"Terminate Merchant","summary":"Terminate Merchant","id":"paths/~1merchants~1{merchant_id}/put/responses/200/content/application~1json/examples/Terminate Merchant"},"paths/~1merchants~1{merchant_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1merchants~1{merchant_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1merchants~1{merchant_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1merchants~1{merchant_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1merchants~1{merchant_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1merchants~1{merchant_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1merchants~1{merchant_id}/put/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"MUwfZPNW3r4EqLMzwgr6txw4 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1merchants~1{merchant_id}/put/responses/404/content/application~1json/examples/NotFound"},"paths/~1merchants~1{merchant_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1merchants~1{merchant_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1merchants~1{merchant_id}~1verifications/post/requestBody/content/application~1json/examples/Verify a Merchant":{"value":{},"key":"Verify a Merchant","summary":"Verify a Merchant","id":"paths/~1merchants~1{merchant_id}~1verifications/post/requestBody/content/application~1json/examples/Verify a Merchant"},"paths/~1merchants~1{merchant_id}~1verifications/post/responses/201/content/application~1json/examples/Pending Merchant Verification":{"value":{"id":"VItpnRDSS7eMXEgbPFMKEmD3","created_at":"2024-09-20T20:46:18.84Z","updated_at":"2024-09-20T20:46:18.91Z","application":"APgFebyumW1TVZK9sbZwAvbx","identity":null,"merchant":"MU7F6JcADa47CT1cwoZAgLFM","merchant_identity":"IDfqVY8AcjQCSdyZSFL4thMn","messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":null,"payment_instrument_verification_details":{"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_domestic":null,"push_to_card_cross_border":null,"card_type":null,"billing_currency":null,"issuer_country":null,"name_verification_results":{"first_name":"UNKNOWN","last_name":"UNKNOWN","middle_name":"UNKNOWN","name":"UNKNOWN"}},"processor":"DUMMY_V1","raw":null,"state":"PENDING","tags":{},"trace_id":"FNXmjmpf1PXHa52KDwFVEEPDy","type":"MERCHANT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VItpnRDSS7eMXEgbPFMKEmD3"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgFebyumW1TVZK9sbZwAvbx"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MU7F6JcADa47CT1cwoZAgLFM"}}},"key":"Pending Merchant Verification","summary":"Pending Merchant Verification","id":"paths/~1merchants~1{merchant_id}~1verifications/post/responses/201/content/application~1json/examples/Pending Merchant Verification"},"paths/~1merchants~1{merchant_id}~1verifications/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1merchants~1{merchant_id}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1merchants~1{merchant_id}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1merchants~1{merchant_id}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1merchants~1{merchant_id}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1merchants~1{merchant_id}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1merchants~1{merchant_id}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1merchants~1{merchant_id}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1microdeposits/get/responses/200/content/application~1json/examples/List of Microdeposits":{"value":{"_embedded":{"microdeposits":[{"id":"microdeposit_g92m9YHXhhndZcmFAUW7Ki","created_at":"2026-09-25T20:05:25.392575Z","updated_at":"2026-09-25T20:05:25.672227Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","expires_at":"2026-10-25T20:05:25.392581Z","instrument":"PI68E8eKh1v4P2eY2PoLrzzT","rail":"RTP","state":"PENDING","verification_attempts":0,"verification_attempts_remaining":3,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_g92m9YHXhhndZcmFAUW7Ki"},"instrument":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI68E8eKh1v4P2eY2PoLrzzT"}}},{"id":"microdeposit_qdiLTmGN7Fkp5CjB2qqQXN","created_at":"2026-09-25T18:53:45.150856Z","updated_at":"2026-09-25T18:53:45.445907Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","expires_at":"2026-10-25T18:53:45.150870Z","instrument":"PIg1HWBme9DpyJb69SeJksHh","rail":"RTP","state":"PENDING","verification_attempts":0,"verification_attempts_remaining":3,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_qdiLTmGN7Fkp5CjB2qqQXN"},"instrument":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIg1HWBme9DpyJb69SeJksHh"}}},{"id":"microdeposit_66nuv1dqF1o98bhRA8Wfnq","created_at":"2026-09-25T16:12:27.644140Z","updated_at":"2026-09-25T16:12:27.932063Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","expires_at":"2026-10-25T16:12:27.644150Z","instrument":"PIwmArPK6WDUg4sRjypsWdx5","rail":"RTP","state":"PENDING","verification_attempts":0,"verification_attempts_remaining":3,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_66nuv1dqF1o98bhRA8Wfnq"},"instrument":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwmArPK6WDUg4sRjypsWdx5"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/microdeposits?limit=3&after_cursor=microdeposit_66nuv1dqF1o98bhRA8Wfnq"}},"page":{"limit":3,"next_cursor":"microdeposit_66nuv1dqF1o98bhRA8Wfnq"}},"key":"List of Microdeposits","summary":"List of Microdeposits","id":"paths/~1microdeposits/get/responses/200/content/application~1json/examples/List of Microdeposits"},"paths/~1microdeposits/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1microdeposits/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1microdeposits/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1microdeposits/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1microdeposits/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"Payment instrument with id PIkfiTDWYhQ4VbtQkC1U1ceJ not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1microdeposits/get/responses/404/content/application~1json/examples/Not found"},"paths/~1microdeposits/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1microdeposits/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Pending verification":{"value":{"id":"microdeposit_faGgpfFJdRKhxRKkg2zk5U","created_at":"2026-09-24T21:48:03.095703Z","updated_at":"2026-09-24T21:48:03.366698Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","expires_at":"2026-10-24T21:48:03.095710Z","instrument":"PIvSQVFLTPkbTLiPq3xFdrDt","rail":"RTP","state":"PENDING","verification_attempts":0,"verification_attempts_remaining":3,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_faGgpfFJdRKhxRKkg2zk5U"},"instrument":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIvSQVFLTPkbTLiPq3xFdrDt"}}},"key":"Microdeposit - Pending verification","summary":"Microdeposit - Pending verification","id":"paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Pending verification"},"paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Verified":{"value":{"id":"microdeposit_faGgpfFJdRKhxRKkg2zk5U","created_at":"2026-09-24T21:48:03.095703Z","updated_at":"2026-09-24T21:48:12.795985Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","expires_at":"2026-10-24T21:48:03.095710Z","instrument":"PIvSQVFLTPkbTLiPq3xFdrDt","rail":"RTP","state":"VERIFIED","verification_attempts":1,"verification_attempts_remaining":2,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_faGgpfFJdRKhxRKkg2zk5U"},"instrument":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIvSQVFLTPkbTLiPq3xFdrDt"}}},"key":"Microdeposit - Verified","summary":"Microdeposit - Verified","id":"paths/~1microdeposits~1{microdeposit_id}/get/responses/200/content/application~1json/examples/Microdeposit - Verified"},"paths/~1microdeposits~1{microdeposit_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_8cFbWq5n2KjXcVbtQkC1U1"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1microdeposits~1{microdeposit_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1microdeposits~1{microdeposit_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_8cFbWq5n2KjXcVbtQkC1U1"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1microdeposits~1{microdeposit_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1microdeposits~1{microdeposit_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"Microdeposit with id microdeposit_8cFbWq5n2KjXcVbtQkC1U1 not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_8cFbWq5n2KjXcVbtQkC1U1"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1microdeposits~1{microdeposit_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1microdeposits~1{microdeposit_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/microdeposits/microdeposit_8cFbWq5n2KjXcVbtQkC1U1"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1microdeposits~1{microdeposit_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - Minimal Fields":{"value":{"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_data":{"max_transaction_amount":500000},"onboarding_link_details":{"expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","return_url":"https://www.finixflowers.com/home","terms_of_service_url":"https://www.finixflowers.com/ToS"}},"key":"Onboarding Form - USA - Minimal Fields","summary":"Onboarding Form - USA - Minimal Fields","id":"paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - Minimal Fields"},"paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - All Fields":{"value":{"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_data":{"ach_max_transaction_amount":100000,"additional_underwriting_data":{"amex_marketing_consent":{"accepted":false,"ip_address":"42.1.1.113","timestamp":"2021-04-28T16:42:55Z","user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)"},"annual_ach_volume":2000000,"average_ach_transfer_amount":200000,"average_card_transfer_amount":20000,"business_description":"CONSUMER","card_volume_distribution":{"card_present_percentage":0,"ecommerce_percentage":100,"mail_order_telephone_order_percentage":0},"merchant_agreement_accepted":true,"merchant_agreement_ip_address":"42.1.1.113","merchant_agreement_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)","refund_policy":"NO_REFUNDS","volume_distribution_by_business_type":{"business_to_business_volume_percentage":90,"business_to_consumer_volume_percentage":10,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0}},"associated_entities":[{"dob":{"day":13,"month":4,"year":1985},"email":"alex.smith@finix.com","first_name":"Alex","last_name":"Smith","personal_address":{"city":"Bellevue","country":"USA","line1":"4848 84th St","postal_code":"98032","region":"WA"},"phone":"14158885080","principal_percentage_ownership":25,"tax_id":"123456789","title":"CFO"}],"country":"USA","entity":{"annual_card_volume":1000000,"business_address":{"city":"Bellevue","country":"USA","line1":"123 Bellevue Way","postal_code":"98039","region":"WA"},"business_name":"Finix Flowers","business_phone":"14158885080","business_tax_id":"123456789","business_type":"CORPORATION","default_statement_descriptor":"DEMOCOMPANY","dob":{"day":13,"month":4,"year":1982},"doing_business_as":"Finix Flowers","email":"john.smith@finix.com","first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":{"day":9,"month":3,"year":2018},"last_name":"Smith","mcc":"4900","ownership_type":"PRIVATE","personal_address":{"city":"Seattle","country":"USA","line1":"123 Boren Ave","postal_code":"98040","region":"WA"},"phone":"14158885080","principal_percentage_ownership":75,"tax_id":"123456789","title":"CEO","url":"https://www.finix.com"},"max_transaction_amount":100000,"payment_instruments":{"account_number":"123456789","account_type":"CHECKING","bank_code":"123456789","country":"USA","currency":"USD","name":"SARAH BANKER","type":"BANK_ACCOUNT"}},"onboarding_link_details":{"expiration_in_minutes":10080,"expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","merchant_ach_max_transaction_amount":100000,"merchant_max_transaction_amount":100000,"return_url":"https://www.finixflowers.com/home","terms_of_service_url":"https://www.finixflowers.com/ToS"}},"key":"Onboarding Form - USA - All Fields","summary":"Onboarding Form - USA - All Fields","id":"paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - USA - All Fields"},"paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields":{"value":{"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_data":{"country":"CAN","max_transaction_amount":100000},"onboarding_link_details":{"expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","return_url":"https://www.finixflowers.com/home","terms_of_service_url":"https://www.finixflowers.com/ToS"}},"key":"Onboarding Form - CAN - Minimal Fields","summary":"Onboarding Form - CAN - Minimal Fields","id":"paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields"},"paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - All Fields":{"value":{"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_data":{"additional_underwriting_data":{"amex_marketing_consent":{"accepted":false,"ip_address":"42.1.1.113","timestamp":"2021-04-28T16:42:55Z","user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)"},"annual_ach_volume":2000000,"average_ach_transfer_amount":200000,"average_card_transfer_amount":20000,"business_description":"CONSUMER","card_volume_distribution":{"card_present_percentage":0,"ecommerce_percentage":100,"mail_order_telephone_order_percentage":0},"merchant_agreement_accepted":true,"merchant_agreement_ip_address":"42.1.1.113","merchant_agreement_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)","refund_policy":"NO_REFUNDS","volume_distribution_by_business_type":{"business_to_business_volume_percentage":90,"business_to_consumer_volume_percentage":10,"consumer_to_consumer_volume_percentage":0,"other_volume_percentage":0,"person_to_person_volume_percentage":0}},"associated_entities":[{"dob":{"day":13,"month":4,"year":1985},"email":"alex.smith@finix.com","first_name":"Alex","last_name":"Smith","personal_address":{"city":"Ottawa","country":"CAN","line1":"789 Rideau St","postal_code":"K1N 5Y3","region":"ON"},"phone":"16138885080","principal_percentage_ownership":25,"tax_id":"123456789","title":"CFO"}],"country":"CAN","entity":{"annual_card_volume":1000000,"business_address":{"city":"Toronto","country":"CAN","line1":"456 King St W","postal_code":"M5V 1K4","region":"ON"},"business_name":"Finix Flowers","business_phone":"16138885080","business_tax_id":"123456789","business_type":"CORPORATION","default_statement_descriptor":"DEMOCOMPANY","dob":{"day":13,"month":4,"year":1982},"doing_business_as":"Finix Flowers","email":"john.smith@finix.com","first_name":"John","has_accepted_credit_cards_previously":false,"incorporation_date":{"day":9,"month":3,"year":2018},"last_name":"Smith","mcc":"4900","ownership_type":"PRIVATE","personal_address":{"city":"Toronto","country":"CAN","line1":"123 Queen St W","postal_code":"M5H 2M9","region":"ON"},"phone":"16138885080","principal_percentage_ownership":75,"tax_id":"123456789","title":"CEO","url":"https://www.finix.com"},"max_transaction_amount":100000,"payment_instruments":{"account_number":"123456789","account_type":"CHECKING","bank_code":"123456789","country":"CAN","currency":"CAD","name":"SARAH BANKER","type":"BANK_ACCOUNT"}},"onboarding_link_details":{"expiration_in_minutes":10080,"expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","merchant_ach_max_transaction_amount":100000,"merchant_max_transaction_amount":100000,"return_url":"https://www.finixflowers.com/home","terms_of_service_url":"https://www.finixflowers.com/ToS"}},"key":"Onboarding Form - CAN - All Fields","summary":"Onboarding Form - CAN - All Fields","id":"paths/~1onboarding_forms/post/requestBody/content/application~1json/examples/Onboarding Form - CAN - All Fields"},"paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - Minimal Fields":{"value":{"id":"obf_eXN4HNVf8oAfcAQQVw95e3","onboarding_data":{"max_transaction_amount":500000,"country":"USA","associated_files":[]},"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_link_details":{"return_url":"https://www.finixflowers.com/home","expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","terms_of_service_url":"https://www.finixflowers.com/ToS"},"onboarding_link":{"expires_at":"2026-09-25T21:05:23.241Z","link_url":"https://sandbox.payments-dashboard.com/merchant-onboarding?formId=REDACTED&applicationId=APc9vhYcPsRuTSpKD9KpMtPe&bearerToken=REDACTED"},"status":"IN_PROGRESS","identity_id":null,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","created_at":"2026-09-25T20:05:23.235792Z","updated_at":"2026-09-25T20:05:23.235792Z","tags":{}},"key":"Onboarding Form - USA - Minimal Fields","summary":"Onboarding Form - USA - Minimal Fields","id":"paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - Minimal Fields"},"paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - All Fields":{"value":{"id":"obf_eWjEqM1TnUG7Vr5Za9nU2P","onboarding_data":{"entity":{"title":"CEO","first_name":"John","last_name":"Smith","email":"john.smith@finix.com","business_name":"Finix Flowers","business_type":"CORPORATION","doing_business_as":"Finix Flowers","phone":"14158885080","business_phone":"14158885080","mcc":"4900","url":"https://www.finix.com","ownership_type":"PRIVATE","default_statement_descriptor":"DEMOCOMPANY","annual_card_volume":"1000000","principal_percentage_ownership":"75","tax_id":"*****6789","business_tax_id":"*****6789","has_accepted_credit_cards_previously":false,"personal_address":{"line1":"123 Boren Ave","city":"Seattle","region":"WA","postal_code":"98040","country":"USA"},"business_address":{"line1":"123 Bellevue Way","city":"Bellevue","region":"WA","postal_code":"98039","country":"USA"},"dob":{"day":13,"month":4,"year":1982},"incorporation_date":{"day":9,"month":3,"year":2018}},"associated_entities":[{"title":"CFO","first_name":"Alex","last_name":"Smith","email":"alex.smith@finix.com","phone":"14158885080","personal_address":{"line1":"4848 84th St","city":"Bellevue","region":"WA","postal_code":"98032","country":"USA"},"dob":{"day":13,"month":4,"year":1985},"principal_percentage_ownership":25,"tax_id":"*****6789"}],"payment_instruments":{"name":"SARAH BANKER","bank_code":"123456789","account_number":"*****6789","account_type":"CHECKING","type":"BANK_ACCOUNT","country":"USA","currency":"USD"},"additional_underwriting_data":{"refund_policy":"NO_REFUNDS","average_ach_transfer_amount":200000,"average_card_transfer_amount":20000,"merchant_agreement_ip_address":"42.1.1.113","merchant_agreement_accepted":true,"merchant_agreement_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)","credit_check_timestamp":null,"credit_check_user_agent":null,"annual_ach_volume":2000000,"business_description":"CONSUMER","volume_distribution_by_business_type":{"other_volume_percentage":0,"person_to_person_volume_percentage":0,"business_to_business_volume_percentage":90,"business_to_consumer_volume_percentage":10,"consumer_to_consumer_volume_percentage":0},"card_volume_distribution":{"ecommerce_percentage":100,"card_present_percentage":0,"mail_order_telephone_order_percentage":0},"amex_marketing_consent":{"accepted":false,"ip_address":"42.1.1.113","user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)","timestamp":"2021-04-28T16:42:55Z"}},"max_transaction_amount":100000,"ach_max_transaction_amount":100000,"country":"USA","associated_files":[]},"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_link_details":{"return_url":"https://www.finixflowers.com/home","expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","merchant_max_transaction_amount":100000,"merchant_ach_max_transaction_amount":100000,"terms_of_service_url":"https://www.finixflowers.com/ToS","expiration_in_minutes":10080},"onboarding_link":{"expires_at":"2026-10-02T20:05:22.899Z","link_url":"https://sandbox.payments-dashboard.com/merchant-onboarding?formId=REDACTED&applicationId=APc9vhYcPsRuTSpKD9KpMtPe&bearerToken=REDACTED"},"status":"IN_PROGRESS","identity_id":null,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","created_at":"2026-09-25T20:05:22.8913Z","updated_at":"2026-09-25T20:05:22.8913Z","tags":{}},"key":"Onboarding Form - USA - All Fields","summary":"Onboarding Form - USA - All Fields","id":"paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - USA - All Fields"},"paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields":{"value":{"id":"obf_eUJJthJa997AqcdF63XdnN","onboarding_data":{"max_transaction_amount":100000,"country":"CAN","associated_files":[]},"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_link_details":{"return_url":"https://www.finixflowers.com/home","expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","terms_of_service_url":"https://www.finixflowers.com/ToS"},"onboarding_link":{"expires_at":"2026-09-25T21:05:22.528Z","link_url":"https://sandbox.payments-dashboard.com/merchant-onboarding?formId=REDACTED&applicationId=APc9vhYcPsRuTSpKD9KpMtPe&bearerToken=REDACTED"},"status":"IN_PROGRESS","identity_id":null,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","created_at":"2026-09-25T20:05:22.519561Z","updated_at":"2026-09-25T20:05:22.519561Z","tags":{}},"key":"Onboarding Form - CAN - Minimal Fields","summary":"Onboarding Form - CAN - Minimal Fields","id":"paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - Minimal Fields"},"paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - All Fields":{"value":{"id":"obf_eRLCSSUd8Hu5MNsgEyuCcE","onboarding_data":{"entity":{"title":"CEO","first_name":"John","last_name":"Smith","email":"john.smith@finix.com","business_name":"Finix Flowers","business_type":"CORPORATION","doing_business_as":"Finix Flowers","phone":"16138885080","business_phone":"16138885080","mcc":"4900","url":"https://www.finix.com","ownership_type":"PRIVATE","default_statement_descriptor":"DEMOCOMPANY","annual_card_volume":"1000000","principal_percentage_ownership":"75","tax_id":"*****6789","business_tax_id":"*****6789","has_accepted_credit_cards_previously":false,"personal_address":{"line1":"123 Queen St W","city":"Toronto","region":"ON","postal_code":"M5H 2M9","country":"CAN"},"business_address":{"line1":"456 King St W","city":"Toronto","region":"ON","postal_code":"M5V 1K4","country":"CAN"},"dob":{"day":13,"month":4,"year":1982},"incorporation_date":{"day":9,"month":3,"year":2018}},"associated_entities":[{"title":"CFO","first_name":"Alex","last_name":"Smith","email":"alex.smith@finix.com","phone":"16138885080","personal_address":{"line1":"789 Rideau St","city":"Ottawa","region":"ON","postal_code":"K1N 5Y3","country":"CAN"},"dob":{"day":13,"month":4,"year":1985},"principal_percentage_ownership":25,"tax_id":"*****6789"}],"payment_instruments":{"name":"SARAH BANKER","bank_code":"123456789","account_number":"*****6789","account_type":"CHECKING","type":"BANK_ACCOUNT","country":"CAN","currency":"CAD"},"additional_underwriting_data":{"refund_policy":"NO_REFUNDS","average_ach_transfer_amount":200000,"average_card_transfer_amount":20000,"merchant_agreement_ip_address":"42.1.1.113","merchant_agreement_accepted":true,"merchant_agreement_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)","credit_check_timestamp":null,"credit_check_user_agent":null,"annual_ach_volume":2000000,"business_description":"CONSUMER","volume_distribution_by_business_type":{"other_volume_percentage":0,"person_to_person_volume_percentage":0,"business_to_business_volume_percentage":90,"business_to_consumer_volume_percentage":10,"consumer_to_consumer_volume_percentage":0},"card_volume_distribution":{"ecommerce_percentage":100,"card_present_percentage":0,"mail_order_telephone_order_percentage":0},"amex_marketing_consent":{"accepted":false,"ip_address":"42.1.1.113","user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)","timestamp":"2021-04-28T16:42:55Z"}},"max_transaction_amount":100000,"country":"CAN","associated_files":[]},"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_link_details":{"return_url":"https://www.finixflowers.com/home","expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","merchant_max_transaction_amount":100000,"merchant_ach_max_transaction_amount":100000,"terms_of_service_url":"https://www.finixflowers.com/ToS","expiration_in_minutes":10080},"onboarding_link":{"expires_at":"2026-10-02T20:05:21.838Z","link_url":"https://sandbox.payments-dashboard.com/merchant-onboarding?formId=REDACTED&applicationId=APc9vhYcPsRuTSpKD9KpMtPe&bearerToken=REDACTED"},"status":"IN_PROGRESS","identity_id":null,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","created_at":"2026-09-25T20:05:21.824498Z","updated_at":"2026-09-25T20:05:21.824498Z","tags":{}},"key":"Onboarding Form - CAN - All Fields","summary":"Onboarding Form - CAN - All Fields","id":"paths/~1onboarding_forms/post/responses/201/content/application~1json/examples/Onboarding Form - CAN - All Fields"},"paths/~1onboarding_forms/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1onboarding_forms/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1onboarding_forms/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1onboarding_forms/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1onboarding_forms/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1onboarding_forms/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1onboarding_forms/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1onboarding_forms/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/200/content/application~1json/examples/Onboarding Form":{"value":{"id":"obf_eWjEqM1TnUG7Vr5Za9nU2P","onboarding_data":{"entity":{"title":"CEO","first_name":"John","last_name":"Smith","email":"john.smith@finix.com","business_name":"Finix Flowers","business_type":"CORPORATION","doing_business_as":"Finix Flowers","phone":"14158885080","business_phone":"14158885080","mcc":"4900","url":"https://www.finix.com","ownership_type":"PRIVATE","default_statement_descriptor":"DEMOCOMPANY","annual_card_volume":"1000000","principal_percentage_ownership":"75","tax_id":"*****6789","business_tax_id":"*****6789","has_accepted_credit_cards_previously":false,"personal_address":{"line1":"123 Boren Ave","city":"Seattle","region":"WA","postal_code":"98040","country":"USA"},"business_address":{"line1":"123 Bellevue Way","city":"Bellevue","region":"WA","postal_code":"98039","country":"USA"},"dob":{"day":13,"month":4,"year":1982},"incorporation_date":{"day":9,"month":3,"year":2018}},"associated_entities":[{"title":"CFO","first_name":"Alex","last_name":"Smith","email":"alex.smith@finix.com","phone":"14158885080","personal_address":{"line1":"4848 84th St","city":"Bellevue","region":"WA","postal_code":"98032","country":"USA"},"dob":{"day":13,"month":4,"year":1985},"principal_percentage_ownership":25,"tax_id":"*****6789"}],"payment_instruments":{"name":"SARAH BANKER","bank_code":"123456789","account_number":"*****6789","account_type":"CHECKING","type":"BANK_ACCOUNT","country":"USA","currency":"USD"},"additional_underwriting_data":{"refund_policy":"NO_REFUNDS","average_ach_transfer_amount":200000,"average_card_transfer_amount":20000,"merchant_agreement_ip_address":"42.1.1.113","merchant_agreement_accepted":true,"merchant_agreement_timestamp":"2021-04-28T16:42:55Z","merchant_agreement_user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)","credit_check_timestamp":null,"credit_check_user_agent":null,"annual_ach_volume":2000000,"business_description":"CONSUMER","volume_distribution_by_business_type":{"other_volume_percentage":0,"person_to_person_volume_percentage":0,"business_to_business_volume_percentage":90,"business_to_consumer_volume_percentage":10,"consumer_to_consumer_volume_percentage":0},"card_volume_distribution":{"ecommerce_percentage":100,"card_present_percentage":0,"mail_order_telephone_order_percentage":0},"amex_marketing_consent":{"accepted":false,"ip_address":"42.1.1.113","user_agent":"Mozilla 5.0 (Macintosh; Intel Mac OS X 10 _14_6)","timestamp":"2021-04-28T16:42:55Z"}},"max_transaction_amount":100000,"ach_max_transaction_amount":100000,"country":"USA","associated_files":[]},"merchant_processors":[{"processor":"DUMMY_V1"}],"onboarding_link_details":{"return_url":"https://www.finixflowers.com/home","expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","merchant_max_transaction_amount":100000,"merchant_ach_max_transaction_amount":100000,"terms_of_service_url":"https://www.finixflowers.com/ToS","expiration_in_minutes":10080},"onboarding_link":{"expires_at":"2026-10-02T20:05:22.899Z","link_url":"https://sandbox.payments-dashboard.com/merchant-onboarding?formId=REDACTED&applicationId=APc9vhYcPsRuTSpKD9KpMtPe&bearerToken=REDACTED"},"status":"IN_PROGRESS","identity_id":null,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","created_at":"2026-09-25T20:05:22.8913Z","updated_at":"2026-09-25T20:05:22.8913Z","tags":{}},"key":"Onboarding Form","summary":"Onboarding Form","id":"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/200/content/application~1json/examples/Onboarding Form"},"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms/obf_4fDUAgocch7q6m4JyzW1HS"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms/obf_4fDUAgocch7q6m4JyzW1HS"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"obf_4fDUAgocch7q6m4JyzW1HS was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms/obf_4fDUAgocch7q6m4JyzW1HS"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms/obf_4fDUAgocch7q6m4JyzW1HS"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1onboarding_forms~1{onboarding_form_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/requestBody/content/application~1json/examples/Onboarding Form Link":{"value":{"expiration_in_minutes":10080,"expired_session_url":"https://www.finixflowers.com/login","fee_details_url":"https://www.finixflowers.com/fee_details","merchant_ach_max_transaction_amount":100000,"merchant_max_transaction_amount":100000,"return_url":"https://www.finixflowers.com/home","terms_of_service_url":"https://www.finixflowers.com/ToS"},"key":"Onboarding Form Link","summary":"Onboarding Form Link","id":"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/requestBody/content/application~1json/examples/Onboarding Form Link"},"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/201/content/application~1json/examples/Onboarding Link":{"value":{"expires_at":"2022-07-11T22:39:55.469Z","link_url":"https://sandbox.payments-dashboard.com/merchant-onboarding?formId=obf_bXQj8iSgYwXf432yJcWbKv&applicationId=APgPDQrLD52TYvqazjHJJchM&bearerToken=eyJhbGciOiJIUzUxMiJ9.eyJvbmJvYXJkaW5nX2Zvcm1faWQiOiJvYmZfYlhRajhpU2dZd1hmNDMyeUpjV2JLdiIsImZlZV9kZXRhaWxzX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS9kb2NzIiwiZXhwaXJlZF9zZXNzaW9uX3VybCI6Imh0dHBzOi8vd3d3LmZpbml4LmNvbS8iLCJpc3MiOiJodHRwczovL3d3dy5maW5peC5jb20iLCJyZXR1cm5fdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL2RvY3MiLCJleHAiOjE2NTc1NzkxOTUsImFwcGxpY2F0aW9uX2lkIjoiQVBnUERRckxENTJUWXZxYXpqSEpKY2hNIiwiaWF0IjoxNjU3NTc3Mzk1LCJtZXJjaGFudF9tYXhfdHJhbnNhY3Rpb25fYW1vdW50IjoxMDAwMDAsInRlcm1zX29mX3NlcnZpY2VfdXJsIjoiaHR0cHM6Ly93d3cuZmluaXguY29tL3Rlcm1zLWFuZC1wb2xpY2llcyJ9.uQvwqhOxSmpX4zMSVn891ClNB_cWHmXhLfyOzRiKRoyn7VAqVOWrO8dJiY-OvN4venPWnPOxM0r3NiIyfgQv6g"},"key":"Onboarding Link","summary":"Onboarding Link","id":"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/201/content/application~1json/examples/Onboarding Link"},"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms/obf_4fDUAgocch7q6m4JyzW1HS/links"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms/obf_4fDUAgocch7q6m4JyzW1HS/links"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms/obf_4fDUAgocch7q6m4JyzW1HS/links"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/onboarding_forms/obf_4fDUAgocch7q6m4JyzW1HS/links"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1onboarding_forms~1{onboarding_form_id}~1links/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card":{"value":{"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","postal_code":"94404","region":"CA"},"expiration_month":12,"expiration_year":2029,"identity":"IDmj1yA97RS4rMjiQgvK3Vio","name":"John Doe","number":"5200828282828210","security_code":"022","type":"PAYMENT_CARD"},"key":"Payment Instrument - Card","summary":"Payment Instrument - Card","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater":{"value":{"account_updater_enabled":true,"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","postal_code":"94404","region":"CA"},"expiration_month":12,"expiration_year":2029,"identity":"IDmj1yA97RS4rMjiQgvK3Vio","name":"John Doe","number":"5200828282828210","security_code":"022","type":"PAYMENT_CARD"},"key":"Payment Instrument - Card - Enable Account Updater","summary":"Payment Instrument - Card - Enable Account Updater","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens":{"value":{"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","postal_code":"94404","region":"CA"},"expiration_month":12,"expiration_year":2029,"identity":"IDmj1yA97RS4rMjiQgvK3Vio","name":"John Doe","network_token_enabled":true,"number":"5200828282828210","security_code":"022","type":"PAYMENT_CARD"},"key":"Payment Instrument - Card - Enable Network Tokens","summary":"Payment Instrument - Card - Enable Network Tokens","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Bank Account":{"value":{"account_number":"0000000019","account_type":"BUSINESS_CHECKING","attempt_bank_account_validation_check":true,"bank_code":"122105278","identity":"IDmj1yA97RS4rMjiQgvK3Vio","name":"Smith & Associates Consulting","type":"BANK_ACCOUNT"},"key":"Payment Instrument - Bank Account","summary":"Payment Instrument - Bank Account","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Bank Account"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Plaid Bank Account":{"value":{"identity":"ID3YZagNmW2bXhJkA6RdUkdS","name":"John Smith","third_party":"PLAID","third_party_token":"processor-sandbox-ab3cff03-8948-1291-f2fe-05634be2c38c","type":"BANK_ACCOUNT"},"key":"Payment Instrument - Plaid Bank Account","summary":"Payment Instrument - Plaid Bank Account","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Plaid Bank Account"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Canadian Bank Account":{"value":{"account_number":"123123123","account_type":"PERSONAL_CHECKING","country":"CAN","currency":"CAD","identity":"IDmj1yA97RS4rMjiQgvK3Vio","institution_number":"123","name":"John Doe","transit_number":"12345","type":"BANK_ACCOUNT"},"key":"Payment Instrument - Canadian Bank Account","summary":"Payment Instrument - Canadian Bank Account","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Canadian Bank Account"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater":{"value":{"account_updater_enabled":true,"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","token":"TKiMxe323RE5Dq3wLVtG8kSW","type":"TOKEN"},"key":"Payment Instrument - Token - Enable Account Updater","summary":"Payment Instrument - Token - Enable Account Updater","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Bank Account":{"value":{"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","token":"TKiMxe323RE5Dq3wLVtG8kSW","type":"TOKEN"},"key":"Payment Instrument - Token - Bank Account","summary":"Payment Instrument - Token - Bank Account","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Bank Account"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Card":{"value":{"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","token":"TKiMxe323RE5Dq3wLVtG8kSW","type":"TOKEN"},"key":"Payment Instrument - Token - Card","summary":"Payment Instrument - Token - Card","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Card"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens":{"value":{"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","network_token_enabled":true,"token":"TKiMxe323RE5Dq3wLVtG8kSW","type":"TOKEN"},"key":"Payment Instrument - Token - Enable Network Tokens","summary":"Payment Instrument - Token - Enable Network Tokens","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay":{"value":{"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","line2":"APT 200","postal_code":"94404","region":"CA"},"identity":"IDmj1yA97RS4rMjiQgvK3Vio","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","name":"John Doe","third_party_token":"{\"token\":{\"paymentMethod\":{\"network\":\"barcode\",\"type\":\"credit\",\"displayName\":\"\"},\"transactionIdentifier\":\"AE514ADAA44E9C3A0A862C7E4EDEE43C422556FA4748B045F1764860557E8EE6\",\"paymentData\":{\"data\":\"IOg9H5\\/hdpccvHZ03ESJwlJXFlmcnI18WXTSOHOPA82ewYoWVyEMiy63HCsdejXsHIR8a+N\\/5aR24OeJrkxheck2AAl5o1LLJ7jL+75scnf7Z55uQmtVyKITTkH22LrC6E6SgMnXaefJYOTUcG1Veqb\\/dXtpPzqaKACEKDkbVivpDk+A2iX5PLROFTMRgmb9a0HYwHOnVGQzXwiHkX1g6f1R4rILUyMaQ5qLxCplE1t\\/guEYmkGBtOb\\/v8+GRDTl8YrC1tOe\\/cs4aQm4cAKJktFQUTbfAApNFBnKI06mtCM7e7qRna\\/YON3gyci035jA7Zq4kBMo7rQB8puGH6dDqB\\/KsPS6Ps+w688+rqEKz16YUJ\\/LMCOzzBM6bCTOS6eouB1eCh3SJdm\\/lmY=\",\"signature\":\"MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwEAAKCAMIID4zCCA4igAwIBAgIITDBBSVGdVDYwCgYIKoZIzj0EAwIwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMB4XDTE5MDUxODAxMzI1N1oXDTI0MDUxNjAxMzI1N1owXzElMCMGA1UEAwwcZWNjLXNtcC1icm9rZXItc2lnbl9VQzQtUFJPRDEUMBIGA1UECwwLaU9TIFN5c3RlbXMxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEwhV37evWx7Ihj2jdcJChIY3HsL1vLCg9hGCV2Ur0pUEbg0IO2BHzQH6DMx8cVMP36zIg1rrV1O\\/0komJPnwPE6OCAhEwggINMAwGA1UdEwEB\\/wQCMAAwHwYDVR0jBBgwFoAUI\\/JJxE+T5O8n5sT2KGw\\/orv9LkswRQYIKwYBBQUHAQEEOTA3MDUGCCsGAQUFBzABhilodHRwOi8vb2NzcC5hcHBsZS5jb20vb2NzcDA0LWFwcGxlYWljYTMwMjCCAR0GA1UdIASCARQwggEQMIIBDAYJKoZIhvdjZAUBMIH+MIHDBggrBgEFBQcCAjCBtgyBs1JlbGlhbmNlIG9uIHRoaXMgY2VydGlmaWNhdGUgYnkgYW55IHBhcnR5IGFzc3VtZXMgYWNjZXB0YW5jZSBvZiB0aGUgdGhlbiBhcHBsaWNhYmxlIHN0YW5kYXJkIHRlcm1zIGFuZCBjb25kaXRpb25zIG9mIHVzZSwgY2VydGlmaWNhdGUgcG9saWN5IGFuZCBjZXJ0aWZpY2F0aW9uIHByYWN0aWNlIHN0YXRlbWVudHMuMDYGCCsGAQUFBwIBFipodHRwOi8vd3d3LmFwcGxlLmNvbS9jZXJ0aWZpY2F0ZWF1dGhvcml0eS8wNAYDVR0fBC0wKzApoCegJYYjaHR0cDovL2NybC5hcHBsZS5jb20vYXBwbGVhaWNhMy5jcmwwHQYDVR0OBBYEFJRX22\\/VdIGGiYl2L35XhQfnm1gkMA4GA1UdDwEB\\/wQEAwIHgDAPBgkqhkiG92NkBh0EAgUAMAoGCCqGSM49BAMCA0kAMEYCIQC+CVcf5x4ec1tV5a+stMcv60RfMBhSIsclEAK2Hr1vVQIhANGLNQpd1t1usXRgNbEess6Hz6Pmr2y9g4CJDcgs3apjMIIC7jCCAnWgAwIBAgIISW0vvzqY2pcwCgYIKoZIzj0EAwIwZzEbMBkGA1UEAwwSQXBwbGUgUm9vdCBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwHhcNMTQwNTA2MjM0NjMwWhcNMjkwNTA2MjM0NjMwWjB6MS4wLAYDVQQDDCVBcHBsZSBBcHBsaWNhdGlvbiBJbnRlZ3JhdGlvbiBDQSAtIEczMSYwJAYDVQQLDB1BcHBsZSBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0eTETMBEGA1UECgwKQXBwbGUgSW5jLjELMAkGA1UEBhMCVVMwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAATwFxGEGddkhdUaXiWBB3bogKLv3nuuTeCN\\/EuT4TNW1WZbNa4i0Jd2DSJOe7oI\\/XYXzojLdrtmcL7I6CmE\\/1RFo4H3MIH0MEYGCCsGAQUFBwEBBDowODA2BggrBgEFBQcwAYYqaHR0cDovL29jc3AuYXBwbGUuY29tL29jc3AwNC1hcHBsZXJvb3RjYWczMB0GA1UdDgQWBBQj8knET5Pk7yfmxPYobD+iu\\/0uSzAPBgNVHRMBAf8EBTADAQH\\/MB8GA1UdIwQYMBaAFLuw3qFYM4iapIqZ3r6966\\/ayySrMDcGA1UdHwQwMC4wLKAqoCiGJmh0dHA6Ly9jcmwuYXBwbGUuY29tL2FwcGxlcm9vdGNhZzMuY3JsMA4GA1UdDwEB\\/wQEAwIBBjAQBgoqhkiG92NkBgIOBAIFADAKBggqhkjOPQQDAgNnADBkAjA6z3KDURaZsYb7NcNWymK\\/9Bft2Q91TaKOvvGcgV5Ct4n4mPebWZ+Y1UENj53pwv4CMDIt1UQhsKMFd2xd8zg7kGf9F3wsIW2WT8ZyaYISb1T4en0bmcubCYkhYQaZDwmSHQAAMYIBjDCCAYgCAQEwgYYwejEuMCwGA1UEAwwlQXBwbGUgQXBwbGljYXRpb24gSW50ZWdyYXRpb24gQ0EgLSBHMzEmMCQGA1UECwwdQXBwbGUgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkxEzARBgNVBAoMCkFwcGxlIEluYy4xCzAJBgNVBAYTAlVTAghMMEFJUZ1UNjANBglghkgBZQMEAgEFAKCBlTAYBgkqhkiG9w0BCQMxCwYJKoZIhvcNAQcBMBwGCSqGSIb3DQEJBTEPFw0yMjA0MDExODE2MjJaMCoGCSqGSIb3DQEJNDEdMBswDQYJYIZIAWUDBAIBBQChCgYIKoZIzj0EAwIwLwYJKoZIhvcNAQkEMSIEINpyGxYyGbl1Kj57wU\\/3PijxngHUcidFy9jukG9sccOHMAoGCCqGSM49BAMCBEcwRQIhAPHvbeAIDmJKf2YGS5xcCoySSeCeFf6ThUsKE3UIPWBJAiBQIZZu4wTlZn7R16N+2iTfvuvzJKgeSv8rAs3YM6z56AAAAAAAAA==\",\"header\":{\"publicKeyHash\":\"eOvce9ya55opFC5EXVWlLwzZRVDEY3Hgakf3+C+0zkc=\",\"ephemeralPublicKey\":\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE3VnkF5JR9cWuYoeT68dUNp\\/2\\/jGaOiid19UfCV9rEkcPomrzFWEZw\\/dN1uU9RTblnrIQPajFj4R2ZKIpYIlkgA==\",\"transactionId\":\"ae514adaa44e9c3a0a862c7e4edee43c422556fa4748b045f1764860557e8ee6\"},\"version\":\"EC_v1\"}}}","type":"APPLE_PAY"},"key":"Payment Instrument - Apple Pay","summary":"Payment Instrument - Apple Pay","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay":{"value":{"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","line2":"APT 200","postal_code":"94404","region":"CA"},"identity":"IDmj1yA97RS4rMjiQgvK3Vio","merchant_identity":"IDwhCCvPwCDEmiFd8Be7pDzN","name":"John Doe","third_party_token":"<GOOGLE_PAY_TOKEN>","type":"GOOGLE_PAY"},"key":"Payment Instrument - Google Pay","summary":"Payment Instrument - Google Pay","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough":{"value":{"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","line2":"APT 200","postal_code":"94404","region":"CA"},"cryptogram":"abc","electronic_commerce_indicator_code":"07","expiration_month":11,"expiration_year":2026,"identity":"IDmj1yA97RS4rMjiQgvK3Vio","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","name":"John Doe","number":"5200828282828210","type":"APPLE_PAY"},"key":"Payment Instrument - Apple Pay - Passthrough","summary":"Payment Instrument - Apple Pay - Passthrough","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough"},"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough":{"value":{"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","line2":"APT 200","postal_code":"94404","region":"CA"},"cryptogram":"abc","electronic_commerce_indicator_code":"07","expiration_month":11,"expiration_year":2026,"identity":"IDmj1yA97RS4rMjiQgvK3Vio","merchant_identity":"IDwhCCvPwCDEmiFd8Be7pDzN","name":"John Doe","number":"5200828282828210","type":"GOOGLE_PAY"},"key":"Payment Instrument - Google Pay - Passthrough","summary":"Payment Instrument - Google Pay - Passthrough","id":"paths/~1payment_instruments/post/requestBody/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card":{"value":{"id":"PImZV8WukUEgB8iFqoSouLt1","created_at":"2026-09-25T20:05:27.37Z","updated_at":"2026-09-25T20:05:27.37Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"PAYMENT_CARD","account_updater_enabled":false,"address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"NON_USA","last_four":"8210","name":"John Doe","network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"UNKNOWN","tags":{},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1/updates"}}},"key":"Payment Instrument - Card","summary":"Payment Instrument - Card","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater":{"value":{"id":"PIdeMUdvaHR55rajDboH1LTv","created_at":"2026-09-25T20:05:24.11Z","updated_at":"2026-09-25T20:05:24.11Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"PAYMENT_CARD","account_updater_enabled":true,"address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"NON_USA","last_four":"8210","name":"John Doe","network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"UNKNOWN","tags":{},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv/updates"}}},"key":"Payment Instrument - Card - Enable Account Updater","summary":"Payment Instrument - Card - Enable Account Updater","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Account Updater"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens":{"value":{"id":"PIkhiAHJBQmHhBQ27fLUYAVh","created_at":"2026-09-25T20:05:28.10Z","updated_at":"2026-09-25T20:05:28.10Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"PAYMENT_CARD","account_updater_enabled":false,"address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"NON_USA","last_four":"8210","name":"John Doe","network_token_enabled":true,"network_token_state":"PENDING","security_code_verification":"UNKNOWN","tags":{},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh/updates"}}},"key":"Payment Instrument - Card - Enable Network Tokens","summary":"Payment Instrument - Card - Enable Network Tokens","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Card - Enable Network Tokens"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account":{"value":{"id":"PI68E8eKh1v4P2eY2PoLrzzT","created_at":"2026-09-25T20:05:25.37Z","updated_at":"2026-09-25T20:05:25.37Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxpMNPZbZqVQfcHzRUJnzkR","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"BANK_ACCOUNT","microdeposit":"microdeposit_g92m9YHXhhndZcmFAUW7Ki","microdeposit_verification_url":"https://link.sandbox-payment-form.com/DKDrmq","account_type":"BUSINESS_CHECKING","bank_account_validation_check":"NOT_ATTEMPTED","bank_code":"122105278","country":"USA","institution_number":null,"masked_account_number":"XXXXXX0019","name":"Smith & Associates Consulting","transit_number":null,"tags":{},"third_party":null,"third_party_token":null,"type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI68E8eKh1v4P2eY2PoLrzzT"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI68E8eKh1v4P2eY2PoLrzzT/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI68E8eKh1v4P2eY2PoLrzzT/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI68E8eKh1v4P2eY2PoLrzzT/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"}}},"key":"Payment Instrument - Bank Account","summary":"Payment Instrument - Bank Account","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Pending Verification":{"value":{"id":"PIpVQkC1U1ceJhQ4Vbt8cFbWq","created_at":"2026-09-25T20:05:25.37Z","updated_at":"2026-09-25T20:05:25.37Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxpMNPZbZqVQfcHzRUJnzkR","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"BANK_ACCOUNT","microdeposit":"microdeposit_g92m9YHXhhndZcmFAUW7Ki","microdeposit_verification_url":"https://link.sandbox-payment-form.com/DKDrmq","account_type":"BUSINESS_CHECKING","bank_account_validation_check":"NOT_ATTEMPTED","bank_code":"122105278","country":"USA","institution_number":null,"masked_account_number":"XXXXXX0019","name":"Smith & Associates Consulting","transit_number":null,"tags":{},"third_party":null,"third_party_token":null,"type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIpVQkC1U1ceJhQ4Vbt8cFbWq"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIpVQkC1U1ceJhQ4Vbt8cFbWq/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIpVQkC1U1ceJhQ4Vbt8cFbWq/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIpVQkC1U1ceJhQ4Vbt8cFbWq/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"}}},"key":"Payment Instrument - Bank Account - Pending Verification","summary":"Payment Instrument - Bank Account - Pending Verification","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Pending Verification"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Verified":{"value":{"id":"PIvbtQkC1U1ceJ4hQ4VbW8cFbq","created_at":"2026-09-25T20:05:25.37Z","updated_at":"2026-09-25T20:05:30.12Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxpMNPZbZqVQfcHzRUJnzkR","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"BANK_ACCOUNT","microdeposit":"microdeposit_g92m9YHXhhndZcmFAUW7Ki","microdeposit_verification_url":null,"account_type":"BUSINESS_CHECKING","bank_account_validation_check":"VALID","bank_code":"122105278","country":"USA","institution_number":null,"masked_account_number":"XXXXXX0019","name":"Smith & Associates Consulting","transit_number":null,"tags":{},"third_party":null,"third_party_token":null,"type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIvbtQkC1U1ceJ4hQ4VbW8cFbq"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIvbtQkC1U1ceJ4hQ4VbW8cFbq/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIvbtQkC1U1ceJ4hQ4VbW8cFbq/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIvbtQkC1U1ceJ4hQ4VbW8cFbq/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"}}},"key":"Payment Instrument - Bank Account - Verified","summary":"Payment Instrument - Bank Account - Verified","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Bank Account - Verified"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Plaid Bank Account":{"value":{"id":"PI9RvCXMLzSHkQpUWxX7dgY4","created_at":"2026-09-25T20:36:43.89Z","updated_at":"2026-09-25T20:36:43.89Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxAutj19xH1AH6ykGx2dwa7","identity":"ID3YZagNmW2bXhJkA6RdUkdS","instrument_type":"BANK_ACCOUNT","account_type":"CHECKING","bank_account_validation_check":"VALID","bank_code":"011401533","country":"USA","institution_number":null,"masked_account_number":"XXXXXXXXXXX0000","name":"John Smith","transit_number":null,"tags":{},"third_party":"PLAID","third_party_token":"processor-sandbox-ab3cff03-8948-1291-f2fe-05634be2c38c","type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI9RvCXMLzSHkQpUWxX7dgY4"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI9RvCXMLzSHkQpUWxX7dgY4/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI9RvCXMLzSHkQpUWxX7dgY4/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI9RvCXMLzSHkQpUWxX7dgY4/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID3YZagNmW2bXhJkA6RdUkdS"}}},"key":"Payment Instrument - Plaid Bank Account","summary":"Payment Instrument - Plaid Bank Account","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Plaid Bank Account"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Canadian Bank Account":{"value":{"id":"PIeHxmfnj5PzqF4JGtbf2Y2m","created_at":"2026-09-25T20:05:27.04Z","updated_at":"2026-09-25T20:05:27.04Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"CAD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPR8RAHfXm1BMYYVJyHWHhw4J","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"BANK_ACCOUNT","account_type":"PERSONAL_CHECKING","bank_account_validation_check":"NOT_ATTEMPTED","bank_code":null,"country":"CAN","institution_number":"123","masked_account_number":"XXXXX3123","name":"John Doe","transit_number":"12345","tags":{},"third_party":null,"third_party_token":null,"type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIeHxmfnj5PzqF4JGtbf2Y2m"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIeHxmfnj5PzqF4JGtbf2Y2m/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIeHxmfnj5PzqF4JGtbf2Y2m/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIeHxmfnj5PzqF4JGtbf2Y2m/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"}}},"key":"Payment Instrument - Canadian Bank Account","summary":"Payment Instrument - Canadian Bank Account","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Canadian Bank Account"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater":{"value":{"id":"PIdeMUdvaHR55rajDboH1LTv","created_at":"2026-09-25T20:05:24.11Z","updated_at":"2026-09-25T20:05:24.11Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"PAYMENT_CARD","account_updater_enabled":true,"address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"NON_USA","last_four":"8210","name":"John Doe","network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"UNKNOWN","tags":{},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIdeMUdvaHR55rajDboH1LTv/updates"}}},"key":"Payment Instrument - Token - Enable Account Updater","summary":"Payment Instrument - Token - Enable Account Updater","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Account Updater"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Bank Account":{"value":{"id":"PIkfiTDWYhQ4VbtQkC1U1ceJ","created_at":"2024-06-21T04:09:03.77Z","updated_at":"2024-06-21T04:09:03.77Z","application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxpMNPZbZqVQfcHzRUJnzkR","identity":"IDjvxGeXBLKH1V9YnWm1CS4n","instrument_type":"BANK_ACCOUNT","account_type":"BUSINESS_CHECKING","bank_account_validation_check":"VALID","bank_code":"122105278","country":"USA","institution_number":null,"masked_account_number":"XXXXXX0019","name":"Smith & Associates Consulting","transit_number":null,"tags":{},"third_party":null,"third_party_token":null,"type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"}}},"key":"Payment Instrument - Token - Bank Account","summary":"Payment Instrument - Token - Bank Account","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Bank Account"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Card":{"value":{"id":"PImmCg3Po7oNi7jaZcXhfkEu","created_at":"2022-10-10T05:32:17.78Z","updated_at":"2022-10-10T05:32:17.78Z","account_updater_enabled":false,"application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDjvxGeXBLKH1V9YnWm1CS4n","instrument_type":"PAYMENT_CARD","address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"USA","last_four":"8210","name":"Amy White","network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"UNKNOWN","tags":{"card_name":"Business Card"},"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImmCg3Po7oNi7jaZcXhfkEu/updates"}}},"key":"Payment Instrument - Token - Card","summary":"Payment Instrument - Token - Card","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Card"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens":{"value":{"id":"PIkhiAHJBQmHhBQ27fLUYAVh","created_at":"2026-09-25T20:05:28.10Z","updated_at":"2026-09-25T20:05:28.10Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"PAYMENT_CARD","account_updater_enabled":false,"address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"NON_USA","last_four":"8210","name":"John Doe","network_token_enabled":true,"network_token_state":"PENDING","security_code_verification":"UNKNOWN","tags":{},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkhiAHJBQmHhBQ27fLUYAVh/updates"}}},"key":"Payment Instrument - Token - Enable Network Tokens","summary":"Payment Instrument - Token - Enable Network Tokens","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Token - Enable Network Tokens"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay":{"value":{"id":"PIpc4vhEkanrNcPihgqMzXw5","created_at":"2026-09-25T20:05:24.67Z","updated_at":"2026-09-25T20:05:24.67Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPR88YBDbK4TqYMUNU8t8fbeQ","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"APPLE_PAY","address":{"line1":"900 Metro Center Blv","line2":"APT 200","city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"bin":"370382","brand":"AMERICAN_EXPRESS","card_type":"CREDIT","expiration_month":11,"expiration_year":2024,"issuer_country":"USA","last_four":"8576","name":"John Doe","tags":{},"third_party":null,"third_party_token":null,"type":"APPLE_PAY","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIpc4vhEkanrNcPihgqMzXw5"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIpc4vhEkanrNcPihgqMzXw5/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIpc4vhEkanrNcPihgqMzXw5/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIpc4vhEkanrNcPihgqMzXw5/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"}}},"key":"Payment Instrument - Apple Pay","summary":"Payment Instrument - Apple Pay","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay":{"value":{"id":"PIxr84Gjvm6Wee3wUbAaBRzK","created_at":"2026-09-25T20:36:37.61Z","updated_at":"2026-09-25T20:36:37.61Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRrcobjtdU98gr4sjiqYR1Qg","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"GOOGLE_PAY","address":{"line1":"900 Metro Center Blv","line2":"APT 200","city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"bin":"411111","brand":"VISA","card_type":"UNKNOWN","expiration_month":12,"expiration_year":2028,"issuer_country":"UNKNOWN","last_four":"1111","name":"John Doe","tags":{},"third_party":null,"third_party_token":null,"type":"GOOGLE_PAY","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIxr84Gjvm6Wee3wUbAaBRzK"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIxr84Gjvm6Wee3wUbAaBRzK/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIxr84Gjvm6Wee3wUbAaBRzK/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIxr84Gjvm6Wee3wUbAaBRzK/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"}}},"key":"Payment Instrument - Google Pay","summary":"Payment Instrument - Google Pay","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough":{"value":{"id":"PIwgh7555RYfKoLPCeu5G1HL","created_at":"2026-09-25T20:05:25.04Z","updated_at":"2026-09-25T20:05:25.04Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"APPLE_PAY","address":{"line1":"900 Metro Center Blv","line2":"APT 200","city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":11,"expiration_year":2026,"issuer_country":"NON_USA","last_four":"8210","name":"John Doe","tags":{},"third_party":null,"third_party_token":null,"type":"APPLE_PAY","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwgh7555RYfKoLPCeu5G1HL"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwgh7555RYfKoLPCeu5G1HL/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwgh7555RYfKoLPCeu5G1HL/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwgh7555RYfKoLPCeu5G1HL/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"}}},"key":"Payment Instrument - Apple Pay - Passthrough","summary":"Payment Instrument - Apple Pay - Passthrough","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay - Passthrough"},"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough":{"value":{"id":"PIrDh9YjhuDhtwMdwm8pCDqq","created_at":"2026-09-25T20:05:27.70Z","updated_at":"2026-09-25T20:05:27.70Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"GOOGLE_PAY","address":{"line1":"900 Metro Center Blv","line2":"APT 200","city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":11,"expiration_year":2026,"issuer_country":"NON_USA","last_four":"8210","name":"John Doe","tags":{},"third_party":null,"third_party_token":null,"type":"GOOGLE_PAY","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIrDh9YjhuDhtwMdwm8pCDqq"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIrDh9YjhuDhtwMdwm8pCDqq/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIrDh9YjhuDhtwMdwm8pCDqq/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIrDh9YjhuDhtwMdwm8pCDqq/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"}}},"key":"Payment Instrument - Google Pay - Passthrough","summary":"Payment Instrument - Google Pay - Passthrough","id":"paths/~1payment_instruments/post/responses/201/content/application~1json/examples/Payment Instrument - Google Pay - Passthrough"},"paths/~1payment_instruments/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1payment_instruments/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1payment_instruments/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instruments/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instruments/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instruments/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instruments/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instruments/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instruments/post/responses/422/content/application~1json/examples/Identity not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"98ea73b7c716b197","message":"Identity 'IDmt1yA97RS4rMjiQgvK3Vio' not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Identity not found","summary":"Identity not found","id":"paths/~1payment_instruments/post/responses/422/content/application~1json/examples/Identity not found"},"paths/~1payment_instruments/get/responses/200/content/application~1json/examples/List of Payment Instruments":{"value":{"_embedded":{"payment_instruments":[{"id":"PI56omrDVoKMf8epFQqvqVnJ","created_at":"2026-09-25T20:39:36.71Z","updated_at":"2026-09-25T20:39:36.71Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxpMNPZbZqVQfcHzRUJnzkR","identity":"IDxwRsj7jP6RuoSJQHQPqibG","instrument_type":"BANK_ACCOUNT","account_type":"BUSINESS_CHECKING","bank_account_validation_check":"VALID","bank_code":"122105278","country":"USA","institution_number":null,"masked_account_number":"XXXXXX0019","name":"Smith & Associates Consulting","transit_number":null,"tags":{},"third_party":null,"third_party_token":null,"type":"BANK_ACCOUNT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI56omrDVoKMf8epFQqvqVnJ"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI56omrDVoKMf8epFQqvqVnJ/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI56omrDVoKMf8epFQqvqVnJ/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI56omrDVoKMf8epFQqvqVnJ/verifications"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDxwRsj7jP6RuoSJQHQPqibG"}}},{"id":"PIwnBTKVnBC7mKsPWCqzaM3s","created_at":"2026-09-25T20:38:26.30Z","updated_at":"2026-09-25T20:38:26.30Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxpMNPZbZqVQfcHzRUJnzkR","identity":"IDsEf4pc4YALXkkB4x8fDqm9","instrument_type":"BANK_ACCOUNT","account_type":"BUSINESS_CHECKING","bank_account_validation_check":"VALID","bank_code":"122105278","country":"USA","institution_number":null,"masked_account_number":"XXXXXX0019","name":"Smith & Associates Consulting","transit_number":null,"tags":{},"third_party":null,"third_party_token":null,"type":"BANK_ACCOUNT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwnBTKVnBC7mKsPWCqzaM3s"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwnBTKVnBC7mKsPWCqzaM3s/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwnBTKVnBC7mKsPWCqzaM3s/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwnBTKVnBC7mKsPWCqzaM3s/verifications"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDsEf4pc4YALXkkB4x8fDqm9"}}},{"id":"PIsHD27A5t7EgREYLpTu2cEk","created_at":"2026-09-25T20:38:24.13Z","updated_at":"2026-09-25T20:38:24.13Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxpMNPZbZqVQfcHzRUJnzkR","identity":"IDvapsWuebxpnk9PszikFwJQ","instrument_type":"BANK_ACCOUNT","account_type":"BUSINESS_CHECKING","bank_account_validation_check":"VALID","bank_code":"122105278","country":"USA","institution_number":null,"masked_account_number":"XXXXXX0019","name":"Smith & Associates Consulting","transit_number":null,"tags":{},"third_party":null,"third_party_token":null,"type":"BANK_ACCOUNT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIsHD27A5t7EgREYLpTu2cEk"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIsHD27A5t7EgREYLpTu2cEk/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIsHD27A5t7EgREYLpTu2cEk/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIsHD27A5t7EgREYLpTu2cEk/verifications"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvapsWuebxpnk9PszikFwJQ"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/payment_instruments?limit=3&after_cursor=PIsHD27A5t7EgREYLpTu2cEk"}},"page":{"limit":3,"next_cursor":"PIsHD27A5t7EgREYLpTu2cEk"}},"key":"List of Payment Instruments","summary":"List of Payment Instruments","id":"paths/~1payment_instruments/get/responses/200/content/application~1json/examples/List of Payment Instruments"},"paths/~1payment_instruments/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instruments/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instruments/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instruments/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instruments/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instruments/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instruments/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1payment_instruments/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/200/content/application~1json/examples/Payment Instrument":{"value":{"id":"PImZV8WukUEgB8iFqoSouLt1","created_at":"2026-09-25T20:05:27.37Z","updated_at":"2026-09-25T20:05:27.37Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"PAYMENT_CARD","account_updater_enabled":false,"address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"NON_USA","last_four":"8210","name":"John Doe","network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"UNKNOWN","tags":{},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImZV8WukUEgB8iFqoSouLt1/updates"}}},"key":"Payment Instrument","summary":"Payment Instrument","id":"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/200/content/application~1json/examples/Payment Instrument"},"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"PInVUXZLswZi6pdcK1T41MuE was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instruments~1{payment_instrument_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument":{"value":{"enabled":false},"key":"Payment Instrument - Disable a Payment Instrument","summary":"Payment Instrument - Disable a Payment Instrument","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Account Updater":{"value":{"account_updater_enabled":true},"key":"Payment Instrument - Enable Account Updater","summary":"Payment Instrument - Enable Account Updater","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Account Updater"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Network Tokens":{"value":{"network_token_enabled":true},"key":"Payment Instrument - Enable Network Tokens","summary":"Payment Instrument - Enable Network Tokens","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Enable Network Tokens"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Card Address":{"value":{"address":{"city":"Los Angeles","country":"USA","line1":"900 Metro Center Blv","line2":"Suite 200","postal_code":"94404","region":"CA"},"merchant":"MUjJUJxMKoL24H8MotYNjtZP","verify_payment_card":true},"key":"Payment Instrument - Update Card Address","summary":"Payment Instrument - Update Card Address","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Card Address"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Name":{"value":{"name":"Todd Murphy"},"key":"Payment Instrument - Update Name","summary":"Payment Instrument - Update Name","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Name"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update and Verify Name":{"value":{"merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","name_verification_details":{"first_name":"Michael","last_name":"Jones","middle_name":"Lewis"},"verify_payment_card":true},"key":"Payment Instrument - Update and Verify Name","summary":"Payment Instrument - Update and Verify Name","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update and Verify Name"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Tags":{"value":{"tags":{"bank_account_name":"Personal Bank Account"}},"key":"Payment Instrument - Update Tags","summary":"Payment Instrument - Update Tags","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Tags"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay":{"value":{"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","line2":"APT 200","postal_code":"94404","region":"CA"}},"key":"Payment Instrument - Add Address for Google or Apple Pay","summary":"Payment Instrument - Add Address for Google or Apple Pay","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Expiration Date":{"value":{"expiration_month":12,"expiration_year":2029},"key":"Payment Instrument - Update Expiration Date","summary":"Payment Instrument - Update Expiration Date","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Update Expiration Date"},"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Verify Microdeposits":{"value":{"verification_code":"FNX7Q2M","verify_microdeposits":true},"key":"Payment Instrument - Verify Microdeposits","summary":"Payment Instrument - Verify Microdeposits","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/requestBody/content/application~1json/examples/Payment Instrument - Verify Microdeposits"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument":{"value":{"id":"PIwbvcQGrEP33HShmYM7BR8o","created_at":"2023-02-28T19:05:56.24Z","updated_at":"2023-02-28T21:16:18.80Z","application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","disabled_code":"USER_INITIATED","disabled_message":"The card has been disabled by a user.","enabled":false,"fingerprint":"FPRd5moHxL3Ltuvk4cczxetCg","identity":"IDpYDM7J9n57q849o9E9yNrG","instrument_type":"BANK_ACCOUNT","account_type":"PERSONAL_SAVINGS","bank_account_validation_check":"NOT_ATTEMPTED","bank_code":"123123123","country":"USA","masked_account_number":"XXXXX3123","name":null,"tags":{"card_name":"Personal Card"},"type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"}}},"key":"Payment Instrument - Disable a Payment Instrument","summary":"Payment Instrument - Disable a Payment Instrument","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Disable a Payment Instrument"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Account Updater":{"value":{"id":"PIwWisLuZNwPBoLbCgQVTCoY","created_at":"2022-08-15T23:13:06.13Z","updated_at":"2024-11-15T12:38:05.33Z","application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRmYp7ejhA3yDjSor4A5Ji2D","identity":"IDgWxBhfGYLLdkhxx2ddYf9K","instrument_type":"PAYMENT_CARD","account_updater_enabled":true,"address":{"line1":"270 Lincoln Center Blv","line2":"Suite 1A","city":"Los Angeles test","region":"CA","postal_code":"90036","country":"USA"},"address_verification":"UNKNOWN","bin":"400000","brand":"VISA","card_type":"UNKNOWN","expiration_month":12,"expiration_year":2029,"issuer_country":"UNKNOWN","last_four":"9979","name":"Todd Murphy","network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"MATCHED","tags":{"card_name":"Personal Card"},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates"}}},"key":"Payment Instrument - Enable Account Updater","summary":"Payment Instrument - Enable Account Updater","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Account Updater"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Network Tokens":{"value":{"id":"PIwWisLuZNwPBoLbCgQVTCoY","created_at":"2022-08-15T23:13:06.13Z","updated_at":"2024-11-15T12:39:28.53Z","application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRmYp7ejhA3yDjSor4A5Ji2D","identity":"IDgWxBhfGYLLdkhxx2ddYf9K","instrument_type":"PAYMENT_CARD","account_updater_enabled":false,"address":{"line1":"270 Lincoln Center Blv","line2":"Suite 1A","city":"Los Angeles test","region":"CA","postal_code":"90036","country":"USA"},"address_verification":"UNKNOWN","bin":"400000","brand":"VISA","card_type":"UNKNOWN","expiration_month":12,"expiration_year":2029,"issuer_country":"UNKNOWN","last_four":"9979","name":"Todd Murphy","network_token_enabled":true,"network_token_state":"PENDING","security_code_verification":"MATCHED","tags":{"card_name":"Personal Card"},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates"}}},"key":"Payment Instrument - Enable Network Tokens","summary":"Payment Instrument - Enable Network Tokens","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Enable Network Tokens"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Card Address":{"value":{"id":"PIwWisLuZNwPBoLbCgQVTCoY","created_at":"2022-08-15T23:13:06.13Z","updated_at":"2023-02-28T21:12:29.72Z","application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRmYp7ejhA3yDjSor4A5Ji2D","identity":"IDgWxBhfGYLLdkhxx2ddYf9K","instrument_type":"PAYMENT_CARD","address":{"line1":"900 Metro Center Blv","line2":"Suite 200","city":"Los Angeles","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"400000","brand":"VISA","card_type":"UNKNOWN","expiration_month":12,"expiration_year":2029,"issuer_country":"UNKNOWN","last_four":"9979","name":"Amy White","security_code_verification":"UNMATCHED","tags":{"card_name":"Business Card","custom_key":"custome value"},"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates"}}},"key":"Payment Instrument - Update Card Address","summary":"Payment Instrument - Update Card Address","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Card Address"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Name":{"value":{"id":"PIwWisLuZNwPBoLbCgQVTCoY","created_at":"2022-08-15T23:13:06.13Z","updated_at":"2023-02-28T21:12:29.72Z","application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRmYp7ejhA3yDjSor4A5Ji2D","identity":"IDgWxBhfGYLLdkhxx2ddYf9K","instrument_type":"PAYMENT_CARD","address":{"line1":"900 Metro Center Blv","line2":"Suite 200","city":"Los Angeles","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"400000","brand":"VISA","card_type":"UNKNOWN","expiration_month":12,"expiration_year":2029,"issuer_country":"UNKNOWN","last_four":"9979","name":"Todd Murphy","security_code_verification":"UNMATCHED","tags":{"card_name":"Business Card","custom_key":"custome value"},"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDgWxBhfGYLLdkhxx2ddYf9K"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwWisLuZNwPBoLbCgQVTCoY/updates"}}},"key":"Payment Instrument - Update Name","summary":"Payment Instrument - Update Name","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Name"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update and Verify Name":{"value":{"id":"PIhWqjo3DU13WmFzWZFLngfa","created_at":"2026-05-26T20:20:59.06Z","updated_at":"2026-09-25T20:05:29.22Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"PAYMENT_CARD","account_updater_enabled":true,"address":{"line1":"270 Lincoln Center Blv","line2":"Suite 1A","city":"Los Angeles","region":"CA","postal_code":"90036","country":"USA"},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"NON_USA","last_four":"8210","name":"Michael Lewis Jones","name_verification_results":{"first_name_verification":"MATCHED","last_name_verification":"MATCHED","middle_name_verification":"MATCHED","name_verification":"MATCHED"},"network_token_enabled":true,"network_token_state":"ACTIVE","security_code_verification":"MATCHED","online_gambing_block_indicator":"testValue","tags":{"card_name":"Personal Card"},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa/updates"}}},"key":"Payment Instrument - Update and Verify Name","summary":"Payment Instrument - Update and Verify Name","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update and Verify Name"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Tags":{"value":{"id":"PIwbvcQGrEP33HShmYM7BR8o","created_at":"2023-02-28T19:05:56.24Z","updated_at":"2023-02-28T21:18:24.79Z","application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRd5moHxL3Ltuvk4cczxetCg","identity":"IDpYDM7J9n57q849o9E9yNrG","instrument_type":"BANK_ACCOUNT","account_type":"PERSONAL_SAVINGS","bank_account_validation_check":"NOT_ATTEMPTED","bank_code":"123123123","country":"USA","masked_account_number":"XXXXX3123","name":null,"tags":{"card_name":"Personal Card"},"type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIwbvcQGrEP33HShmYM7BR8o/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"}}},"key":"Payment Instrument - Update Tags","summary":"Payment Instrument - Update Tags","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Tags"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay":{"value":{"id":"PIf8dyFFcEGBqPhaG22hPyYs","created_at":"2022-10-10T05:36:55.27Z","updated_at":"2022-10-10T05:36:55.27Z","address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","line2":"APT 200","postal_code":"94404","region":"CA"},"application":"APeUfzF5qdNkBCtdgcf3333n","created_via":"API","currency":"USD","enabled":true,"fingerprint":"FPRrcobjtdU98gr4sjiqYR1Qg","identity":"ID78Fh8mcnnzukVzbdoyex5y","instrument_type":"GOOGLE_PAY","bin":"411111","brand":"VISA","card_type":"UNKNOWN","expiration_month":12,"expiration_year":2027,"issuer_country":"UNKNOWN","last_four":"1111","name":"Finix Sandbox","tags":{},"type":"GOOGLE_PAY","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIf8dyFFcEGBqPhaG22hPyYs/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APeUfzF5qdNkBCtdgcf3333n"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID78Fh8mcnnzukVzbdoyex5y"}}},"key":"Payment Instrument - Add Address for Google or Apple Pay","summary":"Payment Instrument - Add Address for Google or Apple Pay","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Add Address for Google or Apple Pay"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Expiration Date":{"value":{"id":"PIhWqjo3DU13WmFzWZFLngfa","created_at":"2026-05-26T20:20:59.06Z","updated_at":"2026-09-25T20:05:28.91Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDmj1yA97RS4rMjiQgvK3Vio","instrument_type":"PAYMENT_CARD","account_updater_enabled":true,"address":{"line1":"270 Lincoln Center Blv","line2":"Suite 1A","city":"Los Angeles","region":"CA","postal_code":"90036","country":"USA"},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"NON_USA","last_four":"8210","name":"Michael Lewis Jones","name_verification_results":{"first_name_verification":"UNKNOWN","last_name_verification":"UNKNOWN","middle_name_verification":"UNKNOWN","name_verification":"UNKNOWN"},"network_token_enabled":true,"network_token_state":"ACTIVE","security_code_verification":"MATCHED","online_gambing_block_indicator":null,"tags":{"card_name":"Personal Card"},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDmj1yA97RS4rMjiQgvK3Vio"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa/updates"}}},"key":"Payment Instrument - Update Expiration Date","summary":"Payment Instrument - Update Expiration Date","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Update Expiration Date"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Verify Microdeposits":{"value":{"id":"PIkfiTDWYhQ4VbtQkC1U1ceJ","created_at":"2026-06-21T04:09:03.77Z","updated_at":"2026-06-23T15:12:44.08Z","application":"APgPDQrLD52TYvqazjHJJchM","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRxpMNPZbZqVQfcHzRUJnzkR","identity":"IDpYDM7J9n57q849o9E9yNrG","instrument_type":"BANK_ACCOUNT","account_type":"BUSINESS_CHECKING","bank_account_validation_check":"NOT_ATTEMPTED","bank_code":"122105278","country":"USA","masked_account_number":"XXXXXX0019","microdeposit":"microdeposit_8cFbWq5n2KjXcVbtQkC1U1","name":"Smith and Associates Consulting","tags":{},"type":"BANK_ACCOUNT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkfiTDWYhQ4VbtQkC1U1ceJ/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDpYDM7J9n57q849o9E9yNrG"}}},"key":"Payment Instrument - Verify Microdeposits","summary":"Payment Instrument - Verify Microdeposits","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/200/content/application~1json/examples/Payment Instrument - Verify Microdeposits"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"PInVUXZLswZi6pdcK1T41MuE was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instruments~1{payment_instrument_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/200/content/application~1json/examples/List of Instrument History Entries":{"value":{"_embedded":{"instrument_history_entries":[{"id":"instrument_history_nAzun1LYhSAJ6rvLeyVAfj","created_at":"2025-06-28T00:34:03.17Z","type":"NUMBER_AND_EXPIRATION_UPDATED","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","payment_instrument_id":"PInVUXZLswZi6pdcK1T41MuE","payment_instrument_type":"PAYMENT_CARD","old_instrument_details":{"bin":"449677","brand":"VISA","expiration_month":"1","expiration_year":"2030","last_four":"5767","fingerprint":"FPRonNPcX7ifi8SXBgcZs7a52"},"new_instrument_details":{"bin":"488700","brand":"VISA","expiration_month":"3","expiration_year":"2040","last_four":"6919","fingerprint":"FPRnpe4F5RfPbyKaATT5Udjif"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history?limit=3&after_cursor=instrument_history_nAzun1LYhSAJ6rvLeyVAfj"}},"page":{"limit":3,"next_cursor":"instrument_history_nAzun1LYhSAJ6rvLeyVAfj"}},"key":"List of Instrument History Entries","summary":"List of Instrument History Entries","id":"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/200/content/application~1json/examples/List of Instrument History Entries"},"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"9f999e7bb56906e3","message":"PdneUXZLswZi6pdcK1T41MeE cannot be decoded","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/404/content/application~1json/examples/Not found"},"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PInVUXZLswZi6pdcK1T41MuE/instrument_history"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1payment_instruments~1{payment_instrument_id}~1instrument_history/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/CVV Verification":{"value":{"merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","security_code":"123","verify_payment_card":true},"key":"CVV Verification","summary":"CVV Verification","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/CVV Verification"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Address Verification":{"value":{"address":{"city":"San Francisco","country":"USA","line1":"900 Metro Center Blv","postal_code":"94404","region":"CA"},"merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","verify_payment_card":true},"key":"Address Verification","summary":"Address Verification","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Address Verification"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Name Verification":{"value":{"merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","name_verification_details":{"first_name":"Michael","last_name":"Jones","middle_name":"Lewis"},"verify_payment_card":true},"key":"Name Verification","summary":"Name Verification","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/requestBody/content/application~1json/examples/Name Verification"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/CVV Verification":{"value":{"id":"PIn8as75qLQFqQ7G4NdBUk58","created_at":"2024-12-04T07:58:45.34Z","updated_at":"2025-08-12T15:40:13.74Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRogKWsRQks2HGaau5eGR9AF","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","instrument_type":"PAYMENT_CARD","account_updater_enabled":false,"address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"UNKNOWN","bin":"489514","brand":"VISA","card_type":"UNKNOWN","expiration_month":12,"expiration_year":2029,"issuer_country":"UNKNOWN","last_four":"0006","name":"Collen Wade","network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"MATCHED","online_gambing_block_indicator":null,"tags":{"card_name":"Business_Card"},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/updates"}}},"key":"CVV Verification","summary":"CVV Verification","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/CVV Verification"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Address Verification":{"value":{"id":"PIn8as75qLQFqQ7G4NdBUk58","created_at":"2024-12-04T07:58:45.34Z","updated_at":"2025-11-07T21:47:31.04Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRogKWsRQks2HGaau5eGR9AF","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","instrument_type":"PAYMENT_CARD","account_updater_enabled":false,"address":{"line1":"900 Metro Center Blv","line2":null,"city":"San Francisco","region":"CA","postal_code":"94404","country":"USA"},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","bin":"489514","brand":"VISA","card_type":"UNKNOWN","expiration_month":12,"expiration_year":2029,"issuer_country":"UNKNOWN","last_four":"0006","name":"Collen Wade","network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"UNKNOWN","online_gambing_block_indicator":null,"tags":{"card_name":"Business_Card"},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/updates"}}},"key":"Address Verification","summary":"Address Verification","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Address Verification"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Name Verification":{"value":{"id":"PIn8as75qLQFqQ7G4NdBUk58","created_at":"2026-05-20T20:20:24.06Z","updated_at":"2026-05-20T20:23:34.48Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"API","currency":"USD","disabled_code":null,"disabled_message":null,"enabled":true,"fingerprint":"FPRiCenDk2SoRng7WjQTr7RJY","identity":"IDpbE3ZuLULv7HQfkkTce55V","instrument_type":"PAYMENT_CARD","account_updater_enabled":false,"address":{"line1":"741 Douglass St","line2":"Apartment 7","city":"San Mateo","region":"CA","postal_code":"94114","country":"USA"},"address_verification":"UNKNOWN","bin":"520082","brand":"MASTERCARD","card_type":"DEBIT","expiration_month":12,"expiration_year":2029,"issuer_country":"USA","last_four":"8210","name":"Michael Lewis Jones","name_verification_results":{"first_name_verification":"MATCHED","last_name_verification":"MATCHED","middle_name_verification":"MATCHED","name_verification":"MATCHED"},"network_token_enabled":false,"network_token_state":"NOT_ENABLED","security_code_verification":"UNKNOWN","tags":{},"third_party":null,"third_party_token":null,"type":"PAYMENT_CARD","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58"},"authorizations":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/authorizations"},"transfers":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/transfers"},"verifications":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/verifications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDpbE3ZuLULv7HQfkkTce55V"},"updates":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk58/updates"}}},"key":"Name Verification","summary":"Name Verification","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/200/content/application~1json/examples/Name Verification"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"PImD9Yi8Q3cCqkaYUUQat8NS was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/requestBody/content/application~1json/examples/Verify Push-to-Card Eligibility":{"value":{"processor":"DUMMY_V1"},"key":"Verify Push-to-Card Eligibility","summary":"Verify Push-to-Card Eligibility","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/requestBody/content/application~1json/examples/Verify Push-to-Card Eligibility"},"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/200/content/application~1json/examples/Verify Push-to-Card Eligibility":{"value":{"id":"VIbv4zMJ9i6VE1TnfA76g4bi","created_at":"2026-09-25T20:05:28.48Z","updated_at":"2026-09-25T20:05:28.54Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":null,"merchant_identity":null,"messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":"PIhWqjo3DU13WmFzWZFLngfa","payment_instrument_verification_details":{"billing_currency":null,"card_type":null,"issuer_country":"UNKNOWN","name_verification_results":{"first_name_verification":"UNKNOWN","last_name_verification":"UNKNOWN","middle_name_verification":"UNKNOWN","name_verification":"UNKNOWN"},"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_cross_border":null,"push_to_card_domestic":null},"processor":"DUMMY_V1","raw":"RawDummyInstrumentVerificationResult","reverification_reason":{"review_type":null,"initiated_by":null,"reason_description":null},"state":"SUCCEEDED","sub_type":null,"tags":{},"trace_id":"e95f0e68-dab6-4b19-b8a3-3d53cdb250d2","type":"PAYMENT_INSTRUMENT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VIbv4zMJ9i6VE1TnfA76g4bi"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"payment_instrument":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIhWqjo3DU13WmFzWZFLngfa"}}},"key":"Verify Push-to-Card Eligibility","summary":"Verify Push-to-Card Eligibility","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/200/content/application~1json/examples/Verify Push-to-Card Eligibility"},"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/verifications"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/verifications"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/verifications"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"32b90f307585c641cdb5fa5f13d35178","message":"PIn8as75qLQFqQ7G4NdBUk5q was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn8as75qLQFqQ7G4NdBUk5q/verifications"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/404/content/application~1json/examples/Not found"},"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImD9Yi8Q3cCqkaYUUQat8NS/verifications"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instruments~1{payment_instrument_id_verify}~1verifications/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1apple_pay_sessions/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay Session":{"value":{"display_name":"Finix Test Merchant","domain":"www.finixtestmerchant.com","merchant_identity":"IDmULj61C8ke6Y7qQiKENJ7","validation_url":"https://apple-pay-gateway-cert.apple.com/paymentservices/paymentSession"},"key":"Payment Instrument - Apple Pay Session","summary":"Payment Instrument - Apple Pay Session","id":"paths/~1apple_pay_sessions/post/requestBody/content/application~1json/examples/Payment Instrument - Apple Pay Session"},"paths/~1apple_pay_sessions/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay Session":{"value":{"id":"APPLEPAYSESSION_xxx","created_at":"2021-11-22T23:58:19.50Z","updated_at":"2021-11-22T23:58:19.50Z","session_details":"{\"epochTimestamp\":1640213041060,\"expiresAt\":1640216641060,\"merchantSessionIdentifier\":\"SSH1524BA9006A944B8B9B8FB60227D9990_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24\",\"nonce\":\"a5ee8554\",\"merchantIdentifier\":\"23D5E1F154400B277E14CC8361878AA0AAFD46B2DF74003C7587B256269102BD\",\"domainName\":\"tj.ngrok.io\",\"displayName\":\"Christmas Shopping\",\"signature\":\"...\",\"operationalAnalyticsIdentifier\":\"Christmas Shopping:23D5E1F154400B277E14CC8361878AA0AAFD46B2DF74003C7587B256269102BD\",\"retries\":0}","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/apple_pay_sessions/APPLEPAYSESSION_xxx"}}},"key":"Payment Instrument - Apple Pay Session","summary":"Payment Instrument - Apple Pay Session","id":"paths/~1apple_pay_sessions/post/responses/201/content/application~1json/examples/Payment Instrument - Apple Pay Session"},"paths/~1apple_pay_sessions/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/apple_pay_sessions"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1apple_pay_sessions/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1apple_pay_sessions/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/apple_pay_sessions"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1apple_pay_sessions/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1apple_pay_sessions/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/apple_pay_sessions"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1apple_pay_sessions/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1apple_pay_sessions/post/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"IDmULj61C8ke6Y7qQiKENJ7 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/apple_pay_sessions"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1apple_pay_sessions/post/responses/404/content/application~1json/examples/Not found"},"paths/~1apple_pay_sessions/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/apple_pay_sessions"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1apple_pay_sessions/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1apple_pay_sessions/post/responses/422/content/application~1json/examples/Domain not registered for Merchant":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"6e8c9440746840ca","message":"This domain name is not registered with Finix for the Merchant","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/apple_pay_sessions"}}}]}},"key":"Domain not registered for Merchant","summary":"Domain not registered for Merchant","id":"paths/~1apple_pay_sessions/post/responses/422/content/application~1json/examples/Domain not registered for Merchant"},"paths/~1payment_instrument_associations/post/requestBody/content/application~1json/examples/Payment Instrument Association":{"value":{"merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","payment_instrument_id":"PInork4cerZvHWYMasYoo8bN","tags":{"order_id":"ORD-123"}},"key":"Payment Instrument Association","summary":"Payment Instrument Association","id":"paths/~1payment_instrument_associations/post/requestBody/content/application~1json/examples/Payment Instrument Association"},"paths/~1payment_instrument_associations/post/responses/201/content/application~1json/examples/Payment Instrument Association":{"value":{"id":"payment_instrument_association_qYzNF1vqUbJgKfb5fLjNzY","created_at":"2026-09-25T20:36:28.94Z","updated_at":"2026-09-25T20:36:28.94Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","enabled":true,"merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","payment_instrument_id":"PInork4cerZvHWYMasYoo8bN","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_qYzNF1vqUbJgKfb5fLjNzY"}}},"key":"Payment Instrument Association","summary":"Payment Instrument Association","id":"paths/~1payment_instrument_associations/post/responses/201/content/application~1json/examples/Payment Instrument Association"},"paths/~1payment_instrument_associations/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1payment_instrument_associations/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1payment_instrument_associations/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instrument_associations/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instrument_associations/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instrument_associations/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instrument_associations/post/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"3937b6ad1bdf63381a68d2cd8ed8d92b","message":"Instrument not found PIcgYZswyRfqSSbvMsxuaHxZ.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1payment_instrument_associations/post/responses/404/content/application~1json/examples/Not found"},"paths/~1payment_instrument_associations/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instrument_associations/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instrument_associations/get/responses/200/content/application~1json/examples/List of Payment Instrument Associations":{"value":{"_embedded":{"payment_instrument_associations":[{"id":"payment_instrument_association_qYzNF1vqUbJgKfb5fLjNzY","created_at":"2026-09-25T20:36:28.94Z","updated_at":"2026-09-25T20:36:28.94Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","enabled":true,"merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","payment_instrument_id":"PInork4cerZvHWYMasYoo8bN","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_qYzNF1vqUbJgKfb5fLjNzY"}}},{"id":"payment_instrument_association_kbdnVJB5TCmy9ZiUxkbqhD","created_at":"2026-09-25T20:06:49.14Z","updated_at":"2026-09-25T20:06:49.14Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","enabled":true,"merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","payment_instrument_id":"PIv7LL36BuF49jPZGhjHGfD9","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_kbdnVJB5TCmy9ZiUxkbqhD"}}},{"id":"payment_instrument_association_i11JH3L1bK3B84W5bLc6Tq","created_at":"2026-09-25T19:44:15.19Z","updated_at":"2026-09-25T19:44:15.19Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","enabled":true,"merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","payment_instrument_id":"PIezDmTvWAh9z5XNErqbT4EA","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_i11JH3L1bK3B84W5bLc6Tq"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations?limit=3&after_cursor=payment_instrument_association_i11JH3L1bK3B84W5bLc6Tq"}},"page":{"limit":3,"next_cursor":"payment_instrument_association_i11JH3L1bK3B84W5bLc6Tq"}},"key":"List of Payment Instrument Associations","summary":"List of Payment Instrument Associations","id":"paths/~1payment_instrument_associations/get/responses/200/content/application~1json/examples/List of Payment Instrument Associations"},"paths/~1payment_instrument_associations/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instrument_associations/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instrument_associations/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instrument_associations/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instrument_associations/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instrument_associations/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instrument_associations/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1payment_instrument_associations/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/200/content/application~1json/examples/Payment Instrument Association":{"value":{"id":"payment_instrument_association_iCfFgdmmVF3koH1gqxmgdV","created_at":"2026-03-26T01:31:42.33Z","updated_at":"2026-03-26T01:31:42.33Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","enabled":true,"merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","payment_instrument_id":"PIdw4YZhGVryETJXjiXVXCWH","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_iCfFgdmmVF3koH1gqxmgdV"}}},"key":"Payment Instrument Association","summary":"Payment Instrument Association","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/200/content/application~1json/examples/Payment Instrument Association"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Tags":{"value":{"tags":{"order_number":"21DFASJSAKAS"}},"key":"Update Payment Instrument Association - Tags","summary":"Update Payment Instrument Association - Tags","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Tags"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Disable":{"value":{"enabled":false},"key":"Update Payment Instrument Association - Disable","summary":"Update Payment Instrument Association - Disable","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/requestBody/content/application~1json/examples/Update Payment Instrument Association - Disable"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Tags":{"value":{"id":"payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd","created_at":"2026-03-26T01:43:46.27Z","updated_at":"2026-09-25T20:05:23.51Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","enabled":true,"merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","payment_instrument_id":"PIt2jKSqrZJftNw95Shx4EkJ","tags":{"order_number":"21DFASJSAKAS"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}},"key":"Update Payment Instrument Association - Tags","summary":"Update Payment Instrument Association - Tags","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Tags"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Disable":{"value":{"id":"payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd","created_at":"2026-03-26T01:43:46.27Z","updated_at":"2026-09-25T20:05:23.77Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","enabled":false,"merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","payment_instrument_id":"PIt2jKSqrZJftNw95Shx4EkJ","tags":{"order_number":"21DFASJSAKAS"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}},"key":"Update Payment Instrument Association - Disable","summary":"Update Payment Instrument Association - Disable","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/200/content/application~1json/examples/Update Payment Instrument Association - Disable"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/payment_instrument_associations/payment_instrument_association_63r1sMopQ1xwfzyQuTTRSd"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1payment_instrument_associations~1{payment_instrument_association_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements/get/responses/200/content/application~1json/examples/List of Settlements":{"value":{"_embedded":{"settlements":[{"id":"STcEvwEkqAirZQnq6HxABFt","created_at":"2026-09-28T21:14:43.90Z","updated_at":"2026-09-30T04:01:02.81Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":null,"funds_flow":null,"identity":"IDcCWCfanQYREwkXmNkuDiKa","is_exception":false,"merchant_id":"MU54k9jqhxipR4TV5UjD4x5u","net_amount":-69,"payment_type":null,"payout_profile_id":"POcEvwzg4L1SyXTJFEk69Tm","processor":"DUMMY_V1","status":"APPROVED","tags":{},"total_amount":0,"total_fee":69,"total_fees":69,"type":"MERCHANT_REVENUE","window_end_time":"2026-09-29T04:00:00.00Z","window_start_time":"2026-09-28T04:00:00.00Z","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvwEkqAirZQnq6HxABFt"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDcCWCfanQYREwkXmNkuDiKa"},"funding_transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvwEkqAirZQnq6HxABFt/funding_transfers"},"transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvwEkqAirZQnq6HxABFt/transfers"},"fees":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvwEkqAirZQnq6HxABFt/transfers?type=fee"},"reversals":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvwEkqAirZQnq6HxABFt/transfers?type=reverse"},"credits":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvwEkqAirZQnq6HxABFt/transfers?type=credit"},"debits":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvwEkqAirZQnq6HxABFt/transfers?type=debit"},"disputes":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvwEkqAirZQnq6HxABFt/transfers?type=dispute"}}},{"id":"STcEvtjUnz6nSwey8UDUXu6","created_at":"2026-09-28T20:30:59.83Z","updated_at":"2026-09-30T04:00:53.39Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":null,"funds_flow":null,"identity":"IDvEVPqD9rnfLCAGnLJphyGT","is_exception":false,"merchant_id":"MUmFY9PWbqJPGtQEN7RXdFAb","net_amount":-69,"payment_type":null,"payout_profile_id":"POcEvtefawJaDPnNWYK87Zk","processor":"DUMMY_V1","status":"APPROVED","tags":{},"total_amount":0,"total_fee":69,"total_fees":69,"type":"MERCHANT_REVENUE","window_end_time":"2026-09-29T04:00:00.00Z","window_start_time":"2026-09-28T04:00:00.00Z","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvtjUnz6nSwey8UDUXu6"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvEVPqD9rnfLCAGnLJphyGT"},"funding_transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvtjUnz6nSwey8UDUXu6/funding_transfers"},"transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvtjUnz6nSwey8UDUXu6/transfers"},"fees":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvtjUnz6nSwey8UDUXu6/transfers?type=fee"},"reversals":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvtjUnz6nSwey8UDUXu6/transfers?type=reverse"},"credits":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvtjUnz6nSwey8UDUXu6/transfers?type=credit"},"debits":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvtjUnz6nSwey8UDUXu6/transfers?type=debit"},"disputes":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvtjUnz6nSwey8UDUXu6/transfers?type=dispute"}}},{"id":"STcEvt2x4c4qGVfWvjCUiRw","created_at":"2026-09-28T20:27:04.22Z","updated_at":"2026-09-30T04:00:52.16Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":null,"funds_flow":null,"identity":"IDiNzjTTtNq1TWMAvrNHbJs3","is_exception":false,"merchant_id":"MUwbLNP3xebpxVfQ63UQ7dxa","net_amount":-69,"payment_type":null,"payout_profile_id":"POcEvsWygu3wSS7ZV9gjRti","processor":"DUMMY_V1","status":"APPROVED","tags":{},"total_amount":0,"total_fee":69,"total_fees":69,"type":"MERCHANT_REVENUE","window_end_time":"2026-09-29T04:00:00.00Z","window_start_time":"2026-09-28T04:00:00.00Z","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvt2x4c4qGVfWvjCUiRw"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDiNzjTTtNq1TWMAvrNHbJs3"},"funding_transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvt2x4c4qGVfWvjCUiRw/funding_transfers"},"transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvt2x4c4qGVfWvjCUiRw/transfers"},"fees":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvt2x4c4qGVfWvjCUiRw/transfers?type=fee"},"reversals":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvt2x4c4qGVfWvjCUiRw/transfers?type=reverse"},"credits":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvt2x4c4qGVfWvjCUiRw/transfers?type=credit"},"debits":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvt2x4c4qGVfWvjCUiRw/transfers?type=debit"},"disputes":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEvt2x4c4qGVfWvjCUiRw/transfers?type=dispute"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements?limit=3&status=APPROVED"},"next":{"href":"https://finix.sandbox-payments-api.com/settlements?limit=3&status=APPROVED&after_cursor=STcEvt2x4c4qGVfWvjCUiRw"}},"page":{"limit":3,"next_cursor":"STcEvt2x4c4qGVfWvjCUiRw"}},"key":"List of Settlements","summary":"List of Settlements","id":"paths/~1settlements/get/responses/200/content/application~1json/examples/List of Settlements"},"paths/~1settlements/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1settlements/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1settlements~1{settlement_id}/get/responses/200/content/application~1json/examples/Settlement":{"value":{"id":"STRQWumUFMWzRAuGL91BUtg","created_at":"2024-12-04T08:52:01.18Z","updated_at":"2024-12-04T12:00:15.83Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":null,"funds_flow":null,"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","is_exception":false,"merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","net_amount":67,"payment_type":null,"payout_profile_id":"POcWbEcDftaX474HhUgDS4pC","processor":"DUMMY_V1","status":"APPROVED","tags":{},"total_amount":100,"total_fee":33,"total_fees":33,"type":"MERCHANT_REVENUE","window_end_time":"2024-12-05T05:00:00.00Z","window_start_time":"2024-12-04T05:00:00.00Z","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"},"funding_transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers"},"transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"},"fees":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers?type=fee"},"reversals":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers?type=reverse"},"credits":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers?type=credit"},"debits":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers?type=debit"},"disputes":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers?type=dispute"}}},"key":"Settlement","summary":"Settlement","id":"paths/~1settlements~1{settlement_id}/get/responses/200/content/application~1json/examples/Settlement"},"paths/~1settlements~1{settlement_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"STRQWumUFMWzRAuGL91BUtg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlements~1{settlement_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1settlements~1{settlement_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}/put/requestBody/content/application~1json/examples/Close Settlement":{"value":{"action":"STOP_ACCRUAL"},"key":"Close Settlement","summary":"Close Settlement","id":"paths/~1settlements~1{settlement_id}/put/requestBody/content/application~1json/examples/Close Settlement"},"paths/~1settlements~1{settlement_id}/put/responses/200/content/application~1json/examples/Settlement":{"value":{"id":"STftJPELA3uTnx6hwKrJEYA7","created_at":"2024-12-16T08:33:42.83Z","updated_at":"2024-12-17T12:00:21.81Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":null,"funds_flow":null,"identity":"ID6UfSm1d4WPiWgLYmbyeo3H","is_exception":false,"merchant_id":"MUmfEGv5bMpSJ9k5TFRUjkmm","net_amount":15057,"payment_type":null,"payout_profile_id":"PO7oz3zVcGFrxPWZoRAy9oXd","processor":"DUMMY_V1","status":"APPROVED","tags":{},"total_amount":15600,"total_fee":543,"total_fees":543,"type":"MERCHANT_REVENUE","window_end_time":"2024-12-17T05:00:00.00Z","window_start_time":"2024-12-16T05:00:00.00Z","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"funding_transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/funding_transfers"},"transfers":{"href":"https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers"},"fees":{"href":"https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=fee"},"reversals":{"href":"https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=reverse"},"credits":{"href":"https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=credit"},"debits":{"href":"https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=debit"},"disputes":{"href":"https://finix.sandbox-payments-api.com/settlements/STftJPELA3uTnx6hwKrJEYA7/transfers?type=dispute"}}},"key":"Settlement","summary":"Settlement","id":"paths/~1settlements~1{settlement_id}/put/responses/200/content/application~1json/examples/Settlement"},"paths/~1settlements~1{settlement_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1settlements~1{settlement_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1settlements~1{settlement_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"STRQWumUFMWzRAuGL91BUtg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlements~1{settlement_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1settlements~1{settlement_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}~1entries/get/responses/200/content/application~1json/examples/List of Settlement Entries":{"value":{"_embedded":{"settlement_entries":[{"id":"SETjqMfu55krwWBEKPLgSUV","created_at":"2024-12-04T08:52:01.53Z","updated_at":"2024-12-04T08:52:01.53Z","amount":3,"currency":"USD","entity_details":{"fee_category":"PROCESSOR"},"entity_id":"TRjWyNpY8KxJYBnqzTHoatze","entity_type":"TRANSFER","parent_entity_id":"TRnErBfrHLgdAi3BqAkWLN27","parent_entity_type":"TRANSFER","ready_to_settle_at":"2024-12-05T08:52:00.81Z","should_fund":true,"subtype":"FEE","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/STRQWumUFMWzRAuGL91BUtg/entries/SETjqMfu55krwWBEKPLgSUV"},"entries":{"href":"https://finix.sandbox-payments-api.com/settlement_engine/settlement/STRQWumUFMWzRAuGL91BUtg"}}},{"id":"SESJcPgWbbYPZgnZUXFcRQJ","created_at":"2024-12-04T08:52:01.39Z","updated_at":"2024-12-04T08:52:01.39Z","amount":30,"currency":"USD","entity_details":{"fee_category":"PROCESSOR"},"entity_id":"TRbkjYx4nJLRAJpRjib3wsg1","entity_type":"TRANSFER","parent_entity_id":"TRnErBfrHLgdAi3BqAkWLN27","parent_entity_type":"TRANSFER","ready_to_settle_at":"2024-12-05T08:52:00.81Z","should_fund":true,"subtype":"FEE","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/STRQWumUFMWzRAuGL91BUtg/entries/SESJcPgWbbYPZgnZUXFcRQJ"},"entries":{"href":"https://finix.sandbox-payments-api.com/settlement_engine/settlement/STRQWumUFMWzRAuGL91BUtg"}}},{"id":"SES3mw1tex35wqhh7fUQTPv","created_at":"2024-12-04T08:52:01.18Z","updated_at":"2024-12-04T08:52:01.18Z","amount":100,"currency":"USD","entity_details":{},"entity_id":"TRnErBfrHLgdAi3BqAkWLN27","entity_type":"TRANSFER","parent_entity_id":null,"parent_entity_type":null,"ready_to_settle_at":"2024-12-05T08:52:00.81Z","should_fund":true,"subtype":"DEBIT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/STRQWumUFMWzRAuGL91BUtg/entries/SES3mw1tex35wqhh7fUQTPv"},"entries":{"href":"https://finix.sandbox-payments-api.com/settlement_engine/settlement/STRQWumUFMWzRAuGL91BUtg"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries?limit=3&after_cursor=SES3mw1tex35wqhh7fUQTPv"}},"page":{"limit":3,"next_cursor":"SES3mw1tex35wqhh7fUQTPv"}},"key":"List of Settlement Entries","summary":"List of Settlement Entries","id":"paths/~1settlements~1{settlement_id}~1entries/get/responses/200/content/application~1json/examples/List of Settlement Entries"},"paths/~1settlements~1{settlement_id}~1entries/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}~1entries/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}~1entries/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}~1entries/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}~1entries/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"STRQWumUFMWzRAuGL91BUtg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlements~1{settlement_id}~1entries/get/responses/404/content/application~1json/examples/Not found"},"paths/~1settlements~1{settlement_id}~1entries/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}~1entries/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}~1entries/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1settlements~1{settlement_id}~1entries/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1settlements~1{settlement_id}~1entries/delete/requestBody/content/application~1json/examples/Remove Settlement Entries":{"value":{"settlement_entry_ids":["SEivAwLLW6c62Nbvvj7TcDAN"]},"key":"Remove Settlement Entries","summary":"Remove Settlement Entries","id":"paths/~1settlements~1{settlement_id}~1entries/delete/requestBody/content/application~1json/examples/Remove Settlement Entries"},"paths/~1settlements~1{settlement_id}~1entries/delete/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}~1entries/delete/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}~1entries/delete/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}~1entries/delete/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}~1entries/delete/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"STRQWumUFMWzRAuGL91BUtg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlements~1{settlement_id}~1entries/delete/responses/404/content/application~1json/examples/Not found"},"paths/~1settlements~1{settlement_id}~1entries/delete/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/entries"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}~1entries/delete/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}~1fees/get/responses/200/content/application~1json/examples/List of Fees":{"value":{"_embedded":{"fees":[{"id":"FE3ftd3ccdG1cepfPyZdBPbS","created_at":"2026-09-25T20:38:31.51Z","updated_at":"2026-09-25T20:38:31.51Z","amount":30,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":null,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","fee_subtype":"PLATFORM_FEE","fee_type":"CARD_FIXED","label":null,"linked_id":"TR3dn2nMmoSc4h8m43aqAdvx","linked_to":"TR3dn2nMmoSc4h8m43aqAdvx","linked_type":"TRANSFER","merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","ready_to_settle_at":"2026-09-26T20:38:31.09Z","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FE3ftd3ccdG1cepfPyZdBPbS"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUcgYZswyRfqSSbvMsxuaHxZ"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR3dn2nMmoSc4h8m43aqAdvx"}}},{"id":"FE3fqDQs8TegGqg98GPXRDYf","created_at":"2026-09-25T20:38:31.51Z","updated_at":"2026-09-25T20:38:31.51Z","amount":577.1,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":null,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","fee_subtype":"PLATFORM_FEE","fee_type":"CARD_BASIS_POINTS","label":null,"linked_id":"TR3dn2nMmoSc4h8m43aqAdvx","linked_to":"TR3dn2nMmoSc4h8m43aqAdvx","linked_type":"TRANSFER","merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","ready_to_settle_at":"2026-09-26T20:38:31.09Z","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FE3fqDQs8TegGqg98GPXRDYf"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUcgYZswyRfqSSbvMsxuaHxZ"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR3dn2nMmoSc4h8m43aqAdvx"}}},{"id":"FE3ckrv4GWMggj3s3h5vBo5s","created_at":"2026-09-25T20:38:30.74Z","updated_at":"2026-09-25T20:38:30.74Z","amount":30,"application":"APc9vhYcPsRuTSpKD9KpMtPe","category":"PROCESSOR","currency":"USD","display_name":null,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","fee_subtype":"PLATFORM_FEE","fee_type":"CARD_FIXED","label":null,"linked_id":"TR3akYq8p48fsJYCSnbUD8Bp","linked_to":"TR3akYq8p48fsJYCSnbUD8Bp","linked_type":"TRANSFER","merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","ready_to_settle_at":"2026-09-26T20:38:30.38Z","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees/FE3ckrv4GWMggj3s3h5vBo5s"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUcgYZswyRfqSSbvMsxuaHxZ"},"transfer":{"href":"https://finix.sandbox-payments-api.com/transfers/TR3akYq8p48fsJYCSnbUD8Bp"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/fees?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/fees?limit=3&after_cursor=FE3ckrv4GWMggj3s3h5vBo5s"}},"page":{"limit":3,"next_cursor":"FE3ckrv4GWMggj3s3h5vBo5s"}},"key":"List of Fees","summary":"List of Fees","id":"paths/~1settlements~1{settlement_id}~1fees/get/responses/200/content/application~1json/examples/List of Fees"},"paths/~1settlements~1{settlement_id}~1fees/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/fees"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}~1fees/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}~1fees/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/fees"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}~1fees/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}~1fees/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/fees"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}~1fees/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}~1fees/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/fees"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1settlements~1{settlement_id}~1fees/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfers":{"value":{"_embedded":{"transfers":[{"id":"TRd9eKzD2ErnYLzzkocyke5d","created_at":"2024-12-04T12:00:17.46Z","updated_at":"2024-12-04T12:01:28.81Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":67,"amount_requested":67,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":"PI4Ppf8rxWYapuEqQr3u6efi","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":null,"operation_key":null,"parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":null,"state":"SUCCEEDED","statement_descriptor":null,"subtype":"SETTLEMENT_MERCHANT","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"6c62d902-22bc-471c-8f89-df65be72a6dc","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRd9eKzD2ErnYLzzkocyke5d"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRd9eKzD2ErnYLzzkocyke5d/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI4Ppf8rxWYapuEqQr3u6efi"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},{"id":"TRtxYyGJXZ5h1kENd2aMeqjK","created_at":"2024-12-04T12:00:16.90Z","updated_at":"2024-12-04T12:01:25.35Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":33,"amount_requested":33,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":"PIn21JMoPv7ETVUsX2veerqz","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":null,"operation_key":null,"parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":null,"state":"SUCCEEDED","statement_descriptor":null,"subtype":"SETTLEMENT_PLATFORM","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"99564345-35ef-4a0e-a95a-87b254ddc32f","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRtxYyGJXZ5h1kENd2aMeqjK"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRtxYyGJXZ5h1kENd2aMeqjK/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIn21JMoPv7ETVUsX2veerqz"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers?limit=3&after_cursor=TRtxYyGJXZ5h1kENd2aMeqjK"}},"page":{"limit":3,"next_cursor":"TRtxYyGJXZ5h1kENd2aMeqjK"}},"key":"List of Settlement Funding Transfers","summary":"List of Settlement Funding Transfers","id":"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfers"},"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"STRQWumUFMWzRAuGL91BUtg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/404/content/application~1json/examples/Not found"},"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfers"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1settlements~1{settlement_id}~1funding_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1settlements~1{settlement_id}~1transfers/delete/requestBody/content/application~1json/examples/Remove a Transfer in a Settlement":{"value":{"transfers":["TRr61njQxaa7AJf6E1C3QwCc"]},"key":"Remove a Transfer in a Settlement","summary":"Remove a Transfer in a Settlement","id":"paths/~1settlements~1{settlement_id}~1transfers/delete/requestBody/content/application~1json/examples/Remove a Transfer in a Settlement"},"paths/~1settlements~1{settlement_id}~1transfers/delete/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}~1transfers/delete/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}~1transfers/delete/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}~1transfers/delete/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}~1transfers/delete/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"STRQWumUFMWzRAuGL91BUtg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlements~1{settlement_id}~1transfers/delete/responses/404/content/application~1json/examples/Not found"},"paths/~1settlements~1{settlement_id}~1transfers/delete/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}~1transfers/delete/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}~1transfers/get/responses/200/content/application~1json/examples/List of Settlement Transfers":{"value":{"_embedded":{"transfers":[{"id":"TRnErBfrHLgdAi3BqAkWLN27","created_at":"2024-12-04T08:51:43.86Z","updated_at":"2026-04-27T20:04:18.96Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":100,"amount_requested":100,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"FALSE","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_CAPTURE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":"2024-12-05T08:52:00.81Z","receipt_last_printed_at":null,"security_code_verification":null,"source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":null,"state":"SUCCEEDED","statement_descriptor":"FLX*FLEX","subtype":"API","supplemental_fee":null,"tags":{"test":"sale"},"third_party_details":null,"tip_amount":null,"trace_id":"27aad359-b747-4159-9f01-bcaa77245d71","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRnErBfrHLgdAi3BqAkWLN27"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers?limit=3&after_cursor=TRnErBfrHLgdAi3BqAkWLN27"}},"page":{"limit":3,"next_cursor":"TRnErBfrHLgdAi3BqAkWLN27"}},"key":"List of Settlement Transfers","summary":"List of Settlement Transfers","id":"paths/~1settlements~1{settlement_id}~1transfers/get/responses/200/content/application~1json/examples/List of Settlement Transfers"},"paths/~1settlements~1{settlement_id}~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}~1transfers/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}~1transfers/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"STRQWumUFMWzRAuGL91BUtg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlements~1{settlement_id}~1transfers/get/responses/404/content/application~1json/examples/Not found"},"paths/~1settlements~1{settlement_id}~1transfers/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/transfers"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1settlements~1{settlement_id}~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfer Attempts":{"value":{"_embedded":{"funding_transfer_attempts":[{"id":"funding_transfer_attempt_xww8CQtgmqRABxpacfiACp","created_at":"2026-09-30T15:33:41.62Z","updated_at":"2026-09-30T15:33:41.62Z","amount":4700,"application_id":"APjzRSvNgT6HYpp3frqnEZFX","currency":"USD","failure_code":null,"failure_message":null,"funding_transfer_id":null,"instrument_id":"PIcsfn7wnj9Ev65i3AvoZVeP","merchant_id":"MUuKBi4UVcS1uFukvcEQoDsx","settlement_id":"STcEx6PSeR2nHurpGMs5jHh","state":"PENDING","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/funding_transfer_attempt_xww8CQtgmqRABxpacfiACp"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STcEx6PSeR2nHurpGMs5jHh/funding_transfer_attempts"}},"page":{"limit":100,"next_cursor":"funding_transfer_attempt_xww8CQtgmqRABxpacfiACp"}},"key":"List of Settlement Funding Transfer Attempts","summary":"List of Settlement Funding Transfer Attempts","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/200/content/application~1json/examples/List of Settlement Funding Transfer Attempts"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"STRQWumUFMWzRAuGL91BUtg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/404/content/application~1json/examples/Not found"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/requestBody/content/application~1json/examples/Create Settlement Funding Transfer Attempt":{"value":{"amount":101059,"instrument_id":"PItzrwXcHBsEC9TLL1JHAB2Z"},"key":"Create Settlement Funding Transfer Attempt","summary":"Create Settlement Funding Transfer Attempt","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/requestBody/content/application~1json/examples/Create Settlement Funding Transfer Attempt"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/201/content/application~1json/examples/Settlement Funding Transfer Attempt":{"value":{"id":"funding_transfer_attempt_wSodeznBbYmvGCHizgaH8f","created_at":"2025-01-30T01:01:00.47Z","updated_at":"2025-01-30T01:01:00.47Z","amount":101059,"application":"APsi2UkE1BgD1aq839yKrwRh","currency":"USD","funding_transfer_id":"TRmjGDHpt53BPhbx2vb5WAhn","instrument_id":"PItzrwXcHBsEC9TLL1JHAB2Z","failure_code":null,"failure_message":null,"merchant_id":"MUngypKf1SE1M1v6tFH8WVe4","state":"SUCCEEDED","settlement_id":"STm8JM3AzYBEw8iBetmCAZut","tags":{},"_links":{"self":{"href":"/settlements/funding_transfer_attempt_wSodeznBbYmvGCHizgaH8f"}}},"key":"Settlement Funding Transfer Attempt","summary":"Settlement Funding Transfer Attempt","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/201/content/application~1json/examples/Settlement Funding Transfer Attempt"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlements/STRQWumUFMWzRAuGL91BUtg/funding_transfer_attempts"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlements~1{settlement_id}~1funding_transfer_attempts/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlement_queue_entries/get/responses/200/content/application~1json/examples/List of Settlement Queue Entries":{"value":{"_embedded":{"settlement_queue_entries":[{"id":"settlement_queue_entry_cEpNn9zACa8WjG8YjmQHw","created_at":"2026-09-25T20:37:06.00Z","updated_at":"2026-09-25T20:37:06.00Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","entity_id":"FEtqY8QFZAVk7e16czzA6CJj","entity_type":"FEE","merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","ready_to_settle_after":"2026-09-26T20:36:22.74Z","state":"PENDING","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_engine/settlement_queue_entries/settlement_queue_entry_cEpNn9zACa8WjG8YjmQHw"}}},{"id":"settlement_queue_entry_cEpNn83jisRkhrHc6MaKd","created_at":"2026-09-25T20:37:05.62Z","updated_at":"2026-09-25T20:37:05.62Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","entity_id":"FEtr1nbNNwqVMVMrJMTc8GnH","entity_type":"FEE","merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","ready_to_settle_after":"2026-09-26T20:36:22.74Z","state":"PENDING","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_engine/settlement_queue_entries/settlement_queue_entry_cEpNn83jisRkhrHc6MaKd"}}},{"id":"settlement_queue_entry_cEpNn7Ra5RCH5k4EyjvCa","created_at":"2026-09-25T20:37:05.59Z","updated_at":"2026-09-25T20:37:05.59Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","entity_id":"FEtr2WTQEmecBxw1C4yyqbAs","entity_type":"FEE","merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","ready_to_settle_after":"2026-09-26T20:36:22.74Z","state":"PENDING","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_engine/settlement_queue_entries/settlement_queue_entry_cEpNn7Ra5RCH5k4EyjvCa"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries?limit=3&after_cursor=settlement_queue_entry_cEpNn7Ra5RCH5k4EyjvCa"}},"page":{"limit":3,"next_cursor":"settlement_queue_entry_cEpNn7Ra5RCH5k4EyjvCa"}},"key":"List of Settlement Queue Entries","summary":"List of Settlement Queue Entries","id":"paths/~1settlement_queue_entries/get/responses/200/content/application~1json/examples/List of Settlement Queue Entries"},"paths/~1settlement_queue_entries/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlement_queue_entries/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlement_queue_entries/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlement_queue_entries/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlement_queue_entries/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlement_queue_entries/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlement_queue_entries/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1settlement_queue_entries/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1settlement_queue_entries/put/requestBody/content/application~1json/examples/Update Settlement Queue Entries":{"value":{"action":"RELEASE","ids":["settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M","settlement_queue_entry_cpuisgcFNiNtBmC4rm4z9"]},"key":"Update Settlement Queue Entries","summary":"Update Settlement Queue Entries","id":"paths/~1settlement_queue_entries/put/requestBody/content/application~1json/examples/Update Settlement Queue Entries"},"paths/~1settlement_queue_entries/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1settlement_queue_entries/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1settlement_queue_entries/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlement_queue_entries/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlement_queue_entries/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlement_queue_entries/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlement_queue_entries/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlement_queue_entries/put/responses/404/content/application~1json/examples/Not found"},"paths/~1settlement_queue_entries/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlement_queue_entries/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1settlement_queue_entries/put/responses/422/content/application~1json/examples/Invalid action":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"3dd0e0d9c2a983e405e3e8801bab3355","message":"RELEASED is not a valid action","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries"}}}]}},"key":"Invalid action","summary":"Invalid action","id":"paths/~1settlement_queue_entries/put/responses/422/content/application~1json/examples/Invalid action"},"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/200/content/application~1json/examples/Settlement Queue Entry":{"value":{"id":"settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M","created_at":"2025-06-25T17:04:01.10Z","updated_at":"2025-06-25T17:33:19.63Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","entity_id":"TRdhp3DszqDKbNvwtn7DDcUi","entity_type":"TRANSFER","merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","platform_id":"PLoMxXWbqwEMT5N1upSaNUbJ","ready_to_settle_after":"2025-06-26T17:04:00.62Z","state":"RELEASED","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_engine/settlement_queue_entries/settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M"}}},"key":"Settlement Queue Entry","summary":"Settlement Queue Entry","id":"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/200/content/application~1json/examples/Settlement Queue Entry"},"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries/settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries/settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries/settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/settlement_queue_entries/settlement_queue_entry_cpuisfQBnnRf7vrxUzo2M"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1settlement_queue_entries~1{settlement_queue_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1split_transfers/get/responses/200/content/application~1json/examples/List of Split Transfers":{"value":{"_embedded":{"split_transfers":[{"id":"split_transfer_qGPFuiseTWRcBtxk76DBg5","created_at":"2026-09-25T20:36:27.03Z","updated_at":"2026-09-25T20:36:27.03Z","amount":100,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","fee":0,"fee_profile_id":"FPmtT4MYmiAs1qjLjneQmk4d","identity_id":"IDgCoio3FfaMSKPNM35atXPU","merchant_id":"MUcgYZswyRfqSSbvMsxuaHxZ","parent_transfer_id":"TRfE8FguNTKJfCUcdtUN5RFT","ready_to_settle_at":null,"tags":{},"type":"CREDIT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers/split_transfer_qGPFuiseTWRcBtxk76DBg5"}}},{"id":"split_transfer_qGPF8tHAXe3xhhUBWr4oWy","created_at":"2026-09-25T20:36:27.03Z","updated_at":"2026-09-25T20:36:27.03Z","amount":300,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","fee":0,"fee_profile_id":"FPryaDMUDq9Tcc5epVpro1Jj","identity_id":"IDjvxGeXBLKH1V9YnWm1CS4n","merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","parent_transfer_id":"TRfE8FguNTKJfCUcdtUN5RFT","ready_to_settle_at":null,"tags":{},"type":"CREDIT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers/split_transfer_qGPF8tHAXe3xhhUBWr4oWy"}}},{"id":"split_transfer_qGPE2kTNrTjUqnquew66Kf","created_at":"2026-09-25T20:36:27.03Z","updated_at":"2026-09-25T20:36:27.03Z","amount":600,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","fee":0,"fee_profile_id":"FPuizPqrhzYLbmJm88u7aqfj","identity_id":"ID6UfSm1d4WPiWgLYmbyeo3H","merchant_id":"MUmfEGv5bMpSJ9k5TFRUjkmm","parent_transfer_id":"TRfE8FguNTKJfCUcdtUN5RFT","ready_to_settle_at":null,"tags":{"key":"value"},"type":"CREDIT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers/split_transfer_qGPE2kTNrTjUqnquew66Kf"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/split_transfers?limit=3&after_cursor=split_transfer_qGPE2kTNrTjUqnquew66Kf"}},"page":{"limit":3,"next_cursor":"split_transfer_qGPE2kTNrTjUqnquew66Kf"}},"key":"List of Split Transfers","summary":"List of Split Transfers","id":"paths/~1split_transfers/get/responses/200/content/application~1json/examples/List of Split Transfers"},"paths/~1split_transfers/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1split_transfers/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1split_transfers/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1split_transfers/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1split_transfers/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1split_transfers/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1split_transfers/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1split_transfers/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1split_transfers~1{split_transfer_id}/get/responses/200/content/application~1json/examples/Split Transfer":{"value":{"id":"split_transfer_97gaitUpcmzqjYYpQbei9j","created_at":"2026-01-12T22:15:51.99Z","updated_at":"2026-01-12T22:15:51.99Z","amount":400,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","fee":100,"fee_profile_id":"FPryaDMUDq9Tcc5epVpro1Jj","identity_id":"IDjvxGeXBLKH1V9YnWm1CS4n","merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","parent_transfer_id":"TR96ZCp2GLvDHPPTMpcsabZi","ready_to_settle_at":"2026-01-13T22:16:03.67Z","tags":{},"type":"DEBIT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers/split_transfer_97gaitUpcmzqjYYpQbei9j"}}},"key":"Split Transfer","summary":"Split Transfer","id":"paths/~1split_transfers~1{split_transfer_id}/get/responses/200/content/application~1json/examples/Split Transfer"},"paths/~1split_transfers~1{split_transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers/split_transfer_97gaitUpcmzqjYYpQbei9j"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1split_transfers~1{split_transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1split_transfers~1{split_transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers/split_transfer_97gaitUpcmzqjYYpQbei9j"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1split_transfers~1{split_transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1split_transfers~1{split_transfer_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"split_transfer_97gaitUpcmzqjYYpQbei9j was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers/split_transfer_97gaitUpcmzqjYYpQbei9j"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1split_transfers~1{split_transfer_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1split_transfers~1{split_transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/split_transfers/split_transfer_97gaitUpcmzqjYYpQbei9j"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1split_transfers~1{split_transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Minimal Fields":{"value":{"amount":10000,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PI6iQcTtJNCS8GZAVKYi5Ueb"},"key":"Transfer - Minimal Fields","summary":"Transfer - Minimal Fields","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Minimal Fields"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - All Fields":{"value":{"3d_secure_authentication":{"cardholder_authentication":"BwABBJQ1AgAAAAAgJDUCAAAAAAA=","electronic_commerce_indicator":"AUTHENTICATED","transaction_id":"EaOMucALHQqLAEGAgk"},"additional_buyer_charges":{"convenience_amount":150},"additional_purchase_data":{"customer_reference_number":"321xyz","customs_duty_amount":10,"discount_amount":100,"item_data":[{"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"commodity_code":"175-62-20","cost_per_unit":500,"item_description":"printing paper","item_discount_amount":100,"merchant_product_code":"1149611","quantity":1,"unit_of_measure":"BX"},{"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"commodity_code":"207-72-54","cost_per_unit":500,"item_description":"printing ink","item_discount_amount":0,"merchant_product_code":"2149612","quantity":1,"unit_of_measure":"CTN"}],"shipping_amount":100},"amount":1000,"currency":"USD","fee_profile":"FP9F2KEnY4wt1XjFvhLBJVjb","ip_address_v4":"104.59.125.155","merchant":"MUe17jKSrfPetoeiJQzzjmA2","security_code":"022","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":[{"amount":500,"merchant":"MUe17jKSrfPetoeiJQzzjmA2","tags":{"key":"value"}},{"amount":500,"fee":100,"merchant":"MUgpr2egkP7mPvYF4HcK1ieV"}],"statement_descriptor":"Flex Gym","tags":{"tip":"50"}},"key":"Transfer - All Fields","summary":"Transfer - All Fields","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - All Fields"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Canada - EFT":{"value":{"amount":662154,"currency":"CAD","merchant":"MUaxXcUAU93JCJutWZVy6KJ5","source":"PIaRNMmrH4WtiBVhaZach99g"},"key":"Transfer - Canada - EFT","summary":"Transfer - Canada - EFT","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Canada - EFT"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure":{"value":{"3d_secure_authentication":{"cardholder_authentication":"BwABBJQ1AgAAAAAgJDUCAAAAAAA=","electronic_commerce_indicator":"AUTHENTICATED","transaction_id":"EaOMucALHQqLAEGAgk"},"amount":92169,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PI6iQcTtJNCS8GZAVKYi5Ueb"},"key":"Transfer - 3D Secure","summary":"Transfer - 3D Secure","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure Session":{"value":{"3d_secure_session":"3d_secure_session_wUCqan1LqeEHbYSwozMcFT","amount":92169,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PI6iQcTtJNCS8GZAVKYi5Ueb"},"key":"Transfer - 3D Secure Session","summary":"Transfer - 3D Secure Session","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - 3D Secure Session"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout":{"value":{"amount":15000,"currency":"USD","destination":"PI95jTbyzcdjhWsgFEK6vqSU","funds_flow_type":"GENERAL_PAYOUT","operation_key":"PUSH_TO_ACH"},"key":"Transfer - Bank Payout","summary":"Transfer - Bank Payout","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout - Same Day":{"value":{"amount":15000,"currency":"USD","destination":"PI95jTbyzcdjhWsgFEK6vqSU","funds_flow_type":"GENERAL_PAYOUT","operation_key":"PUSH_TO_SAME_DAY_ACH"},"key":"Transfer - Bank Payout - Same Day","summary":"Transfer - Bank Payout - Same Day","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Bank Payout - Same Day"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Payout":{"value":{"amount":15000,"currency":"USD","destination":"PIveyqg2bVkKo6SHsstxBSDc","funds_flow_type":"GENERAL_PAYOUT","operation_key":"PUSH_TO_CARD"},"key":"Transfer - Card Payout","summary":"Transfer - Card Payout","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Payout"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present":{"value":{"amount":150,"currency":"USD","device":"DVhCtTEMVHnDPFMh2KQLrFSi","operation_key":"CARD_PRESENT_SALE"},"key":"Transfer - Card Present","summary":"Transfer - Card Present","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund":{"value":{"amount":150,"currency":"USD","device":"DVcazsRGCXuRgxYAqwkbvvci","operation_key":"CARD_PRESENT_UNREFERENCED_REFUND"},"key":"Transfer - Card Present - Unreferenced Refund","summary":"Transfer - Card Present - Unreferenced Refund","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Verification Checks":{"value":{"amount":92169,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","security_code":"022","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Transfer - Card Verification Checks","summary":"Transfer - Card Verification Checks","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Card Verification Checks"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Convenience Fee":{"value":{"additional_buyer_charges":{"convenience_amount":150},"amount":5200,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Transfer - Convenience Fee","summary":"Transfer - Convenience Fee","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Convenience Fee"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Debit Bank Account":{"value":{"amount":6031,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PI9XuhFdFzJ5V9aGYUm6XtH"},"key":"Transfer - Debit Bank Account","summary":"Transfer - Debit Bank Account","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Debit Bank Account"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Fee Profile":{"value":{"amount":662154,"currency":"USD","fee_profile":"FP9F2KEnY4wt1XjFvhLBJVjb","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PI6iQcTtJNCS8GZAVKYi5Ueb"},"key":"Transfer - Fee Profile","summary":"Transfer - Fee Profile","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Fee Profile"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Motor Vehicle Rental":{"value":{"additional_motor_vehicle_rental_data":{"customer_service_number":"8005551234","extra_charge_details":{"one_way_service_fee_amount":5000},"is_no_show":false,"motor_vehicle_rental_agreement_number":"AGR-00142","number_of_days":4,"pickup_address":{"city":"San Francisco","country":"USA","line1":"123 Market St","line2":null,"postal_code":"94105","region":"CA"},"pickup_date":{"day":1,"month":4,"year":2026},"rental_rate":"7500","renter_name":"John Doe","return_address":{"city":"Los Angeles","country":"USA","line1":"456 Hollywood Blvd","line2":"Suite 100","postal_code":"90028","region":"CA"},"return_date":{"day":4,"month":4,"year":2026}},"amount":35000,"currency":"USD","merchant":"MU5Yj7n78VrPjA83zED4NSAt","source":"PIkxmtueemLD6dN9ZoWGHT44","tags":{"order_id":"ORD-123"}},"key":"Transfer - Motor Vehicle Rental","summary":"Transfer - Motor Vehicle Rental","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Motor Vehicle Rental"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Lodging":{"value":{"additional_lodging_data":{"check_in_date":{"day":1,"month":4,"year":2026},"check_out_date":{"day":5,"month":4,"year":2026},"customer_service_phone":"8005551234","extra_charge_details":{"mini_bar_amount":500},"hotel_agreement_number":"HTL98765","is_advance_deposit":false,"is_no_show":false,"number_of_nights":4,"property_phone":"4155559876","room_rate":"10000","room_tax":"1500"},"amount":10000,"currency":"USD","merchant":"MUvjH7MLwEpT3pkVmu7VvNaQ","source":"PIkxmtueemLD6dN9ZoWGHT44","tags":{"order_id":"ORD-123"}},"key":"Transfer - Lodging","summary":"Transfer - Lodging","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Lodging"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Gaming":{"value":{"amount":100,"currency":"USD","ip_address_v4":"192.168.1.1","merchant":"MUmKTKuetVV1MQ5Cq6rjWA5j","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Transfer - Gaming","summary":"Transfer - Gaming","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Gaming"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 2 Processing":{"value":{"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","sales_tax":200},"amount":10000,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PIs3rzrjP9orEjBwtJjhxEjL","statement_descriptor":"FINIX FLOWERS","tags":{"order_id":"ORD-123"}},"key":"Transfer - Level 2 Processing","summary":"Transfer - Level 2 Processing","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 2 Processing"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 3 Processing":{"value":{"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":0,"discount_amount":100,"item_data":[{"amount_excluding_sales_tax":400,"amount_including_sales_tax":440,"commodity_code":"175-62-20","cost_per_unit":500,"item_description":"IT Network Assessment","item_discount_amount":100,"merchant_product_code":"SVC-NET-ASMT","quantity":1,"unit_of_measure":"HUR"},{"amount_excluding_sales_tax":500,"amount_including_sales_tax":550,"commodity_code":"207-72-54","cost_per_unit":500,"item_description":"USB-C Charging Cable 6ft","item_discount_amount":0,"merchant_product_code":"CBL-USBC-6FT","quantity":1,"unit_of_measure":"EA"}],"shipping_amount":100},"amount":990,"currency":"USD","merchant":"MU7noQ1wdgdAeAfymw2rfBMq","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Transfer - Level 3 Processing","summary":"Transfer - Level 3 Processing","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Level 3 Processing"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Partial Authorization":{"value":{"amount":662154,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","partial_authorization":true,"source":"PI6iQcTtJNCS8GZAVKYi5Ueb"},"key":"Transfer - Partial Authorization","summary":"Transfer - Partial Authorization","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Partial Authorization"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Recurring or Unscheduled":{"value":{"amount":10000,"credential_on_file":{"type":"RECURRING"},"currency":"USD","merchant":"MUe17jKSrfPetoeiJQzzjmA2","source":"PIkQgTn1EXbz8Efiam1PmR1D","tags":{"order_id":"ORD-123"}},"key":"Transfer - Recurring or Unscheduled","summary":"Transfer - Recurring or Unscheduled","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Recurring or Unscheduled"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Rent Surcharge":{"value":{"additional_buyer_charges":{"rent_surcharge_amount":1000},"amount":1001000,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PIkxmtueemLD6dN9ZoWGHT44"},"key":"Transfer - Rent Surcharge","summary":"Transfer - Rent Surcharge","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Rent Surcharge"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Split Transaction":{"value":{"amount":1000,"currency":"USD","merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","source":"PI5benj4eVhCL4ALMv6SFxJG","split_transfers":[{"amount":600,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","tags":{"key":"value"}},{"amount":300,"fee":100,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq"},{"amount":100,"merchant":"MUcgYZswyRfqSSbvMsxuaHxZ"}]},"key":"Transfer - Split Transaction","summary":"Transfer - Split Transaction","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Split Transaction"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Surcharge":{"value":{"additional_buyer_charges":{"surcharge_amount":700},"amount":10000,"currency":"USD","merchant":"MU3PLsrxmHcKRKhSoHDJ2FPP","source":"PImn9EAtceoUcBoXG2n73LY9"},"key":"Transfer - Surcharge","summary":"Transfer - Surcharge","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Surcharge"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Card":{"value":{"amount":15000,"currency":"USD","funds_flow_type":"ME_TO_ME","operation_key":"PULL_FROM_CARD","source":"PIveyqg2bVkKo6SHsstxBSDc"},"key":"Transfer - Me to Me Pull - Card","summary":"Transfer - Me to Me Pull - Card","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Card"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank":{"value":{"amount":15000,"currency":"USD","funds_flow_type":"ME_TO_ME","operation_key":"PULL_FROM_ACH","source":"PI95jTbyzcdjhWsgFEK6vqSU"},"key":"Transfer - Me to Me Pull - Bank","summary":"Transfer - Me to Me Pull - Bank","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank - Same Day":{"value":{"amount":15000,"currency":"USD","funds_flow_type":"ME_TO_ME","operation_key":"PULL_FROM_SAME_DAY_ACH","source":"PI95jTbyzcdjhWsgFEK6vqSU"},"key":"Transfer - Me to Me Pull - Bank - Same Day","summary":"Transfer - Me to Me Pull - Bank - Same Day","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Pull - Bank - Same Day"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Card":{"value":{"amount":15000,"currency":"USD","destination":"PIveyqg2bVkKo6SHsstxBSDc","funds_flow_type":"ME_TO_ME","operation_key":"PUSH_TO_CARD","pull_transfer_id":"TR3vKfwCuXmLqPsDYbGYn4NUm"},"key":"Transfer - Me to Me Payout - Card","summary":"Transfer - Me to Me Payout - Card","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Card"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank":{"value":{"amount":15000,"currency":"USD","destination":"PI95jTbyzcdjhWsgFEK6vqSU","funds_flow_type":"ME_TO_ME","operation_key":"PUSH_TO_ACH","pull_transfer_id":"TR4mNhCuXkAqRsDYbJYnBCDe"},"key":"Transfer - Me to Me Payout - Bank","summary":"Transfer - Me to Me Payout - Bank","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank"},"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day":{"value":{"amount":15000,"currency":"USD","destination":"PI95jTbyzcdjhWsgFEK6vqSU","funds_flow_type":"ME_TO_ME","operation_key":"PUSH_TO_SAME_DAY_ACH","pull_transfer_id":"TR5sDhCuXkAqRsEYbJYnSDFg"},"key":"Transfer - Me to Me Payout - Bank - Same Day","summary":"Transfer - Me to Me Payout - Bank - Same Day","id":"paths/~1transfers/post/requestBody/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Minimal Fields":{"value":{"id":"TRhGHpgpTkFhNVNQsDX6QdfD","created_at":"2026-09-25T20:06:00.46Z","updated_at":"2026-09-25T20:06:00.46Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"153601","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:06:00.81Z","raw":null,"ready_to_settle_at":"2026-09-26T20:06:00.46Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"515841cd-5305-409e-90fe-cfa711b3bb10","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhGHpgpTkFhNVNQsDX6QdfD"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhGHpgpTkFhNVNQsDX6QdfD/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhGHpgpTkFhNVNQsDX6QdfD/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhGHpgpTkFhNVNQsDX6QdfD"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhGHpgpTkFhNVNQsDX6QdfD/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - Minimal Fields","summary":"Transfer - Minimal Fields","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Minimal Fields"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - All Fields":{"value":{"id":"TRgQBFEUahEyLZ6zvu3hrqNJ","created_at":"2026-09-25T20:05:48.72Z","updated_at":"2026-09-25T20:05:48.72Z","3d_secure_session":null,"additional_buyer_charges":{"convenience_amount":150,"surcharge_amount":0,"rent_surcharge_amount":0},"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"321xyz","customs_duty_amount":10,"destination_country_code":null,"destination_postal_code":null,"discount_amount":100,"invoice_reference_number":null,"order_date":null,"sales_tax":null,"sales_tax_finix_generated":200,"ship_from_postal_code":null,"shipping_amount":100,"tax_exempt":false,"item_data":[{"cost_per_unit":500,"item_description":"printing paper","item_discount_amount":100,"merchant_product_code":"1149611","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"BX","commodity_code":"175-62-20","sales_tax_amount":100,"sales_tax_rate":0.25},{"cost_per_unit":500,"item_description":"printing ink","item_discount_amount":0,"merchant_product_code":"2149612","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"CTN","commodity_code":"207-72-54","sales_tax_amount":100,"sales_tax_rate":0.25}]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":1000,"amount_requested":1000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FP9F2KEnY4wt1XjFvhLBJVjb","idempotency_id":null,"ip_address_details":null,"merchant":"MUe17jKSrfPetoeiJQzzjmA2","merchant_identity":"ID6NvZy42D7PChZL8GKKD87F","messages":[],"network_details":{"brand":"VISA","authorization_code":"824912","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:49.20Z","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":["split_transfer_gQSpMGjxZRQ452uTarEZZ4","split_transfer_gQSr5EaDoRwr4A7E8EBPzH"],"state":"SUCCEEDED","statement_descriptor":"FLX*FLEX GYM","subtype":"API","supplemental_fee":null,"tags":{"tip":"50"},"third_party_details":null,"tip_amount":null,"trace_id":"2c32aa3f-cd7a-4b44-9b53-56af75957d85","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6NvZy42D7PChZL8GKKD87F"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRgQBFEUahEyLZ6zvu3hrqNJ"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FP9F2KEnY4wt1XjFvhLBJVjb"}}},"key":"Transfer - All Fields","summary":"Transfer - All Fields","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - All Fields"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Canada - EFT":{"value":{"id":"TRp6LDrhdXaXNvnksSeTrrGw","created_at":"2026-09-11T23:30:10.49Z","updated_at":"2026-09-11T23:30:10.49Z","additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":662154,"amount_requested":662154,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"CAD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MUaxXcUAU93JCJutWZVy6KJ5","merchant_identity":"ID6V2Fppq1oUsEd9pzWUbrw6","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-11T23:30:10.85Z","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":"PIaRNMmrH4WtiBVhaZach99g","split_transfers":[],"state":"PENDING","statement_descriptor":"FLX*VIDEO SERVICES","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"c9b6d473-d4bc-4c7d-9d18-ab444de10e4b","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRp6LDrhdXaXNvnksSeTrrGw"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6V2Fppq1oUsEd9pzWUbrw6"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRp6LDrhdXaXNvnksSeTrrGw/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRp6LDrhdXaXNvnksSeTrrGw/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRp6LDrhdXaXNvnksSeTrrGw"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRp6LDrhdXaXNvnksSeTrrGw/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIaRNMmrH4WtiBVhaZach99g"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Canada - EFT","summary":"Transfer - Canada - EFT","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Canada - EFT"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure":{"value":{"id":"TRgKTSSCydKysw1GYbJAcFTB","created_at":"2026-09-25T20:05:47.61Z","updated_at":"2026-09-25T20:05:47.61Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":92169,"amount_requested":92169,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"911286","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:48.01Z","raw":null,"ready_to_settle_at":"2026-09-26T20:05:47.61Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"226ea8e9-30be-4f5a-ad91-5bbec49f481e","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgKTSSCydKysw1GYbJAcFTB"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgKTSSCydKysw1GYbJAcFTB/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgKTSSCydKysw1GYbJAcFTB/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRgKTSSCydKysw1GYbJAcFTB"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgKTSSCydKysw1GYbJAcFTB/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - 3D Secure","summary":"Transfer - 3D Secure","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure Session":{"value":{"id":"TRhVaFXhEnhJgLsoQPD2mC4x","created_at":"2026-09-17T21:09:49.96Z","updated_at":"2026-09-17T21:09:49.96Z","3d_secure_session":"3d_secure_session_9hK2mNp4T761RBv8qwLDYc","additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":92169,"amount_requested":92169,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"912513","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-17T21:09:50.29Z","raw":null,"ready_to_settle_at":"2026-09-18T21:09:49.96Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"5f1c8d30-2b47-4a91-9c02-7ad3e6b18f45","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhVaFXhEnhJgLsoQPD2mC4x"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhVaFXhEnhJgLsoQPD2mC4x/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhVaFXhEnhJgLsoQPD2mC4x/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhVaFXhEnhJgLsoQPD2mC4x"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhVaFXhEnhJgLsoQPD2mC4x/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - 3D Secure Session","summary":"Transfer - 3D Secure Session","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - 3D Secure Session"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout":{"value":{"id":"TRhwTNwDQYAe25or8f3ahw17","created_at":"2025-08-14T20:59:09.39Z","updated_at":"2025-08-14T20:59:09.39Z","additional_buyer_charges":null,"additional_healthcare_data":null,"additional_purchase_data":null,"address_verification":null,"amount":15000,"amount_requested":15000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":"PI95jTbyzcdjhWsgFEK6vqSU","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","funds_flow_type":"GENERAL_PAYOUT","idempotency_id":null,"merchant":"MU2bESfmfedhA2SjcymNvSAX","merchant_identity":"IDA3M8ueFuXaJex7N6jcAR9","messages":[],"network_details":{},"operation_key":"PUSH_TO_ACH","parent_transfer":null,"parent_transfer_trace_id":null,"raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"PENDING","statement_descriptor":null,"subtype":"API","supplemental_fee":null,"tags":{},"tip_amount":null,"trace_id":"340c933b-309c-43fd-b2a4-de6b6f9bd246","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhwTNwDQYAe25or8f3ahw17"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhwTNwDQYAe25or8f3ahw17/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Bank Payout","summary":"Transfer - Bank Payout","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout - Same Day":{"value":{"id":"TRxjGTvFYSESwnAjGUD5TM1U","created_at":"2025-08-15T13:37:30.38Z","updated_at":"2025-08-15T13:37:30.38Z","additional_buyer_charges":null,"additional_healthcare_data":null,"additional_purchase_data":null,"address_verification":null,"amount":15000,"amount_requested":15000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":"PI95jTbyzcdjhWsgFEK6vqSU","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","funds_flow_type":"GENERAL_PAYOUT","idempotency_id":null,"merchant":"MU2bESfmfedhA2SjcymNvSAX","merchant_identity":"IDA3M8ueFuXaJex7N6jcAR9","messages":[],"network_details":null,"operation_key":"PUSH_TO_SAME_DAY_ACH","parent_transfer":null,"parent_transfer_trace_id":null,"raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"PENDING","statement_descriptor":null,"subtype":"API","supplemental_fee":null,"tags":{},"tip_amount":null,"trace_id":"d7f9404e-38ea-4c88-8901-808fd2cf7aad","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRxjGTvFYSESwnAjGUD5TM1U"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRxjGTvFYSESwnAjGUD5TM1U/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Bank Payout - Same Day","summary":"Transfer - Bank Payout - Same Day","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Bank Payout - Same Day"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Convenience Fee":{"value":{"id":"TRhamnpnNBvkFxyL9PYzG2Yk","created_at":"2026-09-25T20:05:53.11Z","updated_at":"2026-09-25T20:05:53.11Z","3d_secure_session":null,"additional_buyer_charges":{"convenience_amount":150,"surcharge_amount":0,"rent_surcharge_amount":0},"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":5200,"amount_requested":5200,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"162854","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:53.54Z","raw":null,"ready_to_settle_at":"2026-09-26T20:05:53.11Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"822c2134-ed0d-426b-ba14-e41f7656ca03","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhamnpnNBvkFxyL9PYzG2Yk"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhamnpnNBvkFxyL9PYzG2Yk/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhamnpnNBvkFxyL9PYzG2Yk/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhamnpnNBvkFxyL9PYzG2Yk"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhamnpnNBvkFxyL9PYzG2Yk/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - Convenience Fee","summary":"Transfer - Convenience Fee","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Convenience Fee"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Payout":{"value":{"id":"TR4YRkgpoqUPFUBvDTZDksuc","created_at":"2026-09-17T21:09:52.84Z","updated_at":"2026-09-17T21:09:52.84Z","additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":15000,"amount_requested":15000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":"PIveyqg2bVkKo6SHsstxBSDc","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","funds_flow_type":"GENERAL_PAYOUT","idempotency_id":null,"ip_address_details":null,"merchant":"MUuNdhs7uVYcjocWugeBbpRo","merchant_identity":"IDbPrApp2adDVqG4QQzoo58E","messages":[],"network_details":null,"operation_key":"PUSH_TO_CARD","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-17T21:09:53.68Z","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"SUCCEEDED","statement_descriptor":null,"subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"2bf177b1-03fb-4fad-9591-47aeb5ef44fc","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TR4YRkgpoqUPFUBvDTZDksuc"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDbPrApp2adDVqG4QQzoo58E"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TR4YRkgpoqUPFUBvDTZDksuc/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TR4YRkgpoqUPFUBvDTZDksuc/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TR4YRkgpoqUPFUBvDTZDksuc"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TR4YRkgpoqUPFUBvDTZDksuc/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIveyqg2bVkKo6SHsstxBSDc"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Card Payout","summary":"Transfer - Card Payout","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Payout"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present":{"value":{"id":"TRh1Hi8syrYLkLuHaXCpz7it","created_at":"2026-09-28T20:30:55.60Z","updated_at":"2026-09-28T20:30:55.60Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":150,"amount_requested":150,"application":"APc9vhYcPsRuTSpKD9KpMtPe","card_present_details":{"approval_code":"187548","brand":"VISA","digital_signature_file_id":null,"emv_data":{"application_identifier":"A0000000031010","application_label":"VISA CREDIT","application_preferred_name":null,"application_transaction_counter":"0034","cryptogram":"ARQC CDB1F6ACB6EB7D64","issuer_code_table_index":null,"network_emv_response":null,"pin_verified":false,"tags":null},"entry_mode":"CONTACTLESS","masked_account_number":"476173******0010","name":null,"payment_type":"CREDIT"},"created_via":"CARD_PRESENT_SEMI_INTEGRATED_API","currency":"USD","destination":null,"device":"DVhCtTEMVHnDPFMh2KQLrFSi","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MUmFY9PWbqJPGtQEN7RXdFAb","merchant_identity":"IDvEVPqD9rnfLCAGnLJphyGT","messages":[],"network_details":{"brand":"VISA","authorization_code":"187548","acquirer_reference_number":null},"operation_key":"CARD_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-28T20:30:59.37Z","raw":null,"ready_to_settle_at":"2026-09-29T20:30:55.60Z","receipt_last_printed_at":null,"security_code_verification":null,"source":"PIf37GxCn3oRz5E5ddGvS9Um","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":0,"trace_id":"4031ea12-b9b5-4882-9cd0-3cad2f8cfb56","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRh1Hi8syrYLkLuHaXCpz7it"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvEVPqD9rnfLCAGnLJphyGT"},"device":{"href":"https://finix.sandbox-payments-api.com/devices/DVhCtTEMVHnDPFMh2KQLrFSi"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRh1Hi8syrYLkLuHaXCpz7it/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRh1Hi8syrYLkLuHaXCpz7it/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRh1Hi8syrYLkLuHaXCpz7it"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRh1Hi8syrYLkLuHaXCpz7it/disputes"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Card Present","summary":"Transfer - Card Present","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund":{"value":{"id":"TRkPHLevpKTpSZMHAyrek4yB","created_at":"2026-09-28T21:14:44.35Z","updated_at":"2026-09-28T21:14:44.35Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":150,"amount_requested":150,"application":"APc9vhYcPsRuTSpKD9KpMtPe","card_present_details":{"approval_code":"359262","brand":"VISA","digital_signature_file_id":null,"emv_data":{"application_identifier":"A0000000031010","application_label":"VISA CREDIT","application_preferred_name":null,"application_transaction_counter":"0039","cryptogram":"ARQC BA1F823D37EE3B6E","issuer_code_table_index":null,"network_emv_response":null,"pin_verified":false,"tags":null},"entry_mode":"CONTACTLESS","masked_account_number":"476173******0010","name":null,"payment_type":"CREDIT"},"created_via":"CARD_PRESENT_SEMI_INTEGRATED_API","currency":"USD","destination":"PI33pAX4H9jrTh9qEimd6C6M","device":"DVcazsRGCXuRgxYAqwkbvvci","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MU54k9jqhxipR4TV5UjD4x5u","merchant_identity":"IDcCWCfanQYREwkXmNkuDiKa","messages":[],"network_details":null,"operation_key":"CARD_PRESENT_UNREFERENCED_REFUND","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-28T21:14:48.06Z","raw":null,"ready_to_settle_at":"2026-09-29T21:14:44.35Z","receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"e40bc6d2-3ecb-43e5-a7cf-dae93e3c8da1","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkPHLevpKTpSZMHAyrek4yB"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDcCWCfanQYREwkXmNkuDiKa"},"device":{"href":"https://finix.sandbox-payments-api.com/devices/DVcazsRGCXuRgxYAqwkbvvci"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkPHLevpKTpSZMHAyrek4yB/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkPHLevpKTpSZMHAyrek4yB/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRkPHLevpKTpSZMHAyrek4yB"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkPHLevpKTpSZMHAyrek4yB/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI33pAX4H9jrTh9qEimd6C6M"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Card Present - Unreferenced Refund","summary":"Transfer - Card Present - Unreferenced Refund","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Present - Unreferenced Refund"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Verification Checks":{"value":{"id":"TRh5xMqUnSpj92bdwLqmhn2e","created_at":"2026-09-25T20:05:51.98Z","updated_at":"2026-09-25T20:05:51.98Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":92169,"amount_requested":92169,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"257175","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:52.34Z","raw":null,"ready_to_settle_at":"2026-09-26T20:05:51.98Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"278ce2f4-3dc1-4259-b28c-43f46cb7d918","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRh5xMqUnSpj92bdwLqmhn2e"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRh5xMqUnSpj92bdwLqmhn2e/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRh5xMqUnSpj92bdwLqmhn2e/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRh5xMqUnSpj92bdwLqmhn2e"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRh5xMqUnSpj92bdwLqmhn2e/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - Card Verification Checks","summary":"Transfer - Card Verification Checks","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Card Verification Checks"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Debit Bank Account":{"value":{"id":"TRheCfmbxcrZHriLeNbCvmPn","created_at":"2026-09-25T20:05:54.11Z","updated_at":"2026-09-25T20:05:54.11Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":6031,"amount_requested":6031,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:54.47Z","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":"PI9XuhFdFzJ5V9aGYUm6XtH","split_transfers":[],"state":"PENDING","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"5f60656e-6841-437c-ad93-94d85cbb30bd","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRheCfmbxcrZHriLeNbCvmPn"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRheCfmbxcrZHriLeNbCvmPn/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRheCfmbxcrZHriLeNbCvmPn/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRheCfmbxcrZHriLeNbCvmPn"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRheCfmbxcrZHriLeNbCvmPn/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI9XuhFdFzJ5V9aGYUm6XtH"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - Debit Bank Account","summary":"Transfer - Debit Bank Account","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Debit Bank Account"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Fee Profile":{"value":{"id":"TRhiHXDg7rRgf5vPiMZFoX7t","created_at":"2026-09-25T20:05:55.07Z","updated_at":"2026-09-25T20:05:55.07Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":662154,"amount_requested":662154,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FP9F2KEnY4wt1XjFvhLBJVjb","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"053676","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:55.43Z","raw":null,"ready_to_settle_at":"2026-09-26T20:05:55.07Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"b1f2ecb7-1d5a-4542-97f6-3b248f9c339d","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhiHXDg7rRgf5vPiMZFoX7t"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhiHXDg7rRgf5vPiMZFoX7t/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhiHXDg7rRgf5vPiMZFoX7t/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhiHXDg7rRgf5vPiMZFoX7t"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhiHXDg7rRgf5vPiMZFoX7t/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FP9F2KEnY4wt1XjFvhLBJVjb"}}},"key":"Transfer - Fee Profile","summary":"Transfer - Fee Profile","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Fee Profile"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Motor Vehicle Rental":{"value":{"id":"TRgWNtbeY47YsrBYtn9Sfvmz","created_at":"2026-09-25T20:05:50.17Z","updated_at":"2026-09-25T20:05:50.17Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":{"motor_vehicle_rental_agreement_number":"AGR-00142","customer_service_number":"8005551234","extra_charge_details":{"one_way_service_fee_amount":5000,"fuel_amount":null,"extra_mileage_amount":null,"parking_violation_amount":null,"late_return_amount":null,"insurance_amount":null},"is_no_show":false,"number_of_days":4,"pickup_address":{"line1":"123 Market St","line2":null,"city":"San Francisco","region":"CA","postal_code":"94105","country":"USA"},"pickup_date":{"day":1,"month":4,"year":2026},"rental_rate":"7500","renter_name":"John Doe","return_address":{"line1":"456 Hollywood Blvd","line2":"Suite 100","city":"Los Angeles","region":"CA","postal_code":"90028","country":"USA"},"return_date":{"day":4,"month":4,"year":2026}},"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":35000,"amount_requested":35000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MU5Yj7n78VrPjA83zED4NSAt","merchant_identity":"IDuaq66v5kqLZCSy31BjKCwD","messages":[],"network_details":{"brand":"VISA","authorization_code":"971406","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:50.58Z","raw":null,"ready_to_settle_at":"2026-09-26T20:05:50.17Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*DEMOCOMPANY","subtype":"API","supplemental_fee":null,"tags":{"order_id":"ORD-123"},"third_party_details":null,"tip_amount":null,"trace_id":"78abe7fd-719b-492d-a57c-9a2ecf9881b4","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgWNtbeY47YsrBYtn9Sfvmz"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDuaq66v5kqLZCSy31BjKCwD"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgWNtbeY47YsrBYtn9Sfvmz/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgWNtbeY47YsrBYtn9Sfvmz/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRgWNtbeY47YsrBYtn9Sfvmz"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgWNtbeY47YsrBYtn9Sfvmz/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Motor Vehicle Rental","summary":"Transfer - Motor Vehicle Rental","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Motor Vehicle Rental"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Lodging":{"value":{"id":"TRht8YChYc6Ut4Kd42K8hLW7","created_at":"2026-09-25T20:05:57.28Z","updated_at":"2026-09-25T20:05:57.28Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":{"check_in_date":{"day":1,"month":4,"year":2026},"check_out_date":{"day":5,"month":4,"year":2026},"customer_service_phone":"8005551234","extra_charge_details":{"mini_bar_amount":500,"gift_shop_amount":null,"phone_amount":null,"restaurant_amount":null,"laundry_amount":null,"other_amount":null},"hotel_agreement_number":"HTL98765","is_advance_deposit":false,"is_no_show":false,"number_of_nights":4,"property_phone":"4155559876","room_rate":"10000","room_tax":"1500"},"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MUvjH7MLwEpT3pkVmu7VvNaQ","merchant_identity":"IDvLLvjXjjKQYXFdrYWvVfWJ","messages":[],"network_details":{"brand":"VISA","authorization_code":"041618","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:57.65Z","raw":null,"ready_to_settle_at":"2026-09-26T20:05:57.28Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*DEMOCOMPANY","subtype":"API","supplemental_fee":null,"tags":{"order_id":"ORD-123"},"third_party_details":null,"tip_amount":null,"trace_id":"941ab294-91e2-469b-9340-e09e78000473","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRht8YChYc6Ut4Kd42K8hLW7"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvLLvjXjjKQYXFdrYWvVfWJ"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRht8YChYc6Ut4Kd42K8hLW7/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRht8YChYc6Ut4Kd42K8hLW7/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRht8YChYc6Ut4Kd42K8hLW7"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRht8YChYc6Ut4Kd42K8hLW7/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Lodging","summary":"Transfer - Lodging","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Lodging"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Gaming":{"value":{"id":"TRhoi8D5QRiYA9EQN3PJRY16","created_at":"2026-09-25T20:05:56.14Z","updated_at":"2026-09-25T20:05:56.14Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":100,"amount_requested":100,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MUmKTKuetVV1MQ5Cq6rjWA5j","merchant_identity":"IDsuVDUYpUS2pzqQVsuUZzNH","messages":[],"network_details":{"brand":"VISA","authorization_code":"966766","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:56.54Z","raw":null,"ready_to_settle_at":"2026-09-26T20:05:56.14Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"4d0c8356-bec8-4b61-b0a0-b675a47adc01","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhoi8D5QRiYA9EQN3PJRY16"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDsuVDUYpUS2pzqQVsuUZzNH"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhoi8D5QRiYA9EQN3PJRY16/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhoi8D5QRiYA9EQN3PJRY16/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhoi8D5QRiYA9EQN3PJRY16"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhoi8D5QRiYA9EQN3PJRY16/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Gaming","summary":"Transfer - Gaming","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Gaming"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 2 Processing":{"value":{"id":"TRhxcLi5xeLc6S6cw15RFFFe","created_at":"2026-09-25T20:05:58.23Z","updated_at":"2026-09-25T20:05:58.23Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":null,"destination_country_code":null,"destination_postal_code":null,"discount_amount":null,"invoice_reference_number":null,"order_date":null,"sales_tax":200,"sales_tax_finix_generated":null,"ship_from_postal_code":null,"shipping_amount":null,"tax_exempt":false,"item_data":[]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":10000,"amount_requested":10000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"MASTERCARD","authorization_code":"179463","acquirer_reference_number":"79996936117050932176855"},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:58.57Z","raw":null,"ready_to_settle_at":"2026-09-26T20:05:58.23Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIs3rzrjP9orEjBwtJjhxEjL","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{"order_id":"ORD-123"},"third_party_details":null,"tip_amount":null,"trace_id":"4c050b39-9589-4253-b3b6-f71428629e22","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhxcLi5xeLc6S6cw15RFFFe"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhxcLi5xeLc6S6cw15RFFFe/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhxcLi5xeLc6S6cw15RFFFe/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhxcLi5xeLc6S6cw15RFFFe"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhxcLi5xeLc6S6cw15RFFFe/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIs3rzrjP9orEjBwtJjhxEjL"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - Level 2 Processing","summary":"Transfer - Level 2 Processing","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 2 Processing"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 3 Processing":{"value":{"id":"TRfwbgfgsSV664hPUPfpvScc","created_at":"2026-10-27T20:24:49.75Z","updated_at":"2026-10-27T20:24:49.75Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"PO-2024-3842","customs_duty_amount":0,"destination_country_code":null,"destination_postal_code":null,"discount_amount":100,"invoice_reference_number":null,"order_date":null,"sales_tax":null,"sales_tax_finix_generated":90,"ship_from_postal_code":null,"shipping_amount":100,"tax_exempt":false,"item_data":[{"cost_per_unit":500,"item_description":"IT Network Assessment","item_discount_amount":100,"merchant_product_code":"SVC-NET-ASMT","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":440,"unit_of_measure":"HUR","commodity_code":"175-62-20","sales_tax_amount":40,"sales_tax_rate":0.1},{"cost_per_unit":500,"item_description":"USB-C Charging Cable 6ft","item_discount_amount":0,"merchant_product_code":"CBL-USBC-6FT","quantity":1,"amount_excluding_sales_tax":500,"amount_including_sales_tax":550,"unit_of_measure":"EA","commodity_code":"207-72-54","sales_tax_amount":50,"sales_tax_rate":0.1}]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":990,"amount_requested":990,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPryaDMUDq9Tcc5epVpro1Jj","idempotency_id":null,"ip_address_details":null,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":{"brand":"VISA","authorization_code":"099376","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-10-27T20:24:50.21Z","raw":null,"ready_to_settle_at":"2026-10-28T20:24:49.75Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FLEX","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"73f9986c-58fe-4459-99b7-fa0775eefbc1","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRfwbgfgsSV664hPUPfpvScc"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRfwbgfgsSV664hPUPfpvScc/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRfwbgfgsSV664hPUPfpvScc/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRfwbgfgsSV664hPUPfpvScc"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRfwbgfgsSV664hPUPfpvScc/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPryaDMUDq9Tcc5epVpro1Jj"}}},"key":"Transfer - Level 3 Processing","summary":"Transfer - Level 3 Processing","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Level 3 Processing"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Partial Authorization":{"value":{"id":"TRhMMA5yhM1mUm4p5tRcY4Qf","created_at":"2026-09-25T20:06:01.64Z","updated_at":"2026-09-25T20:06:01.64Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":662154,"amount_requested":662154,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"477472","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:06:02.02Z","raw":null,"ready_to_settle_at":"2026-09-26T20:06:01.64Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"218535f9-6b7d-40a3-b4ba-099f3a8c3a9f","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhMMA5yhM1mUm4p5tRcY4Qf"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhMMA5yhM1mUm4p5tRcY4Qf/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhMMA5yhM1mUm4p5tRcY4Qf/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhMMA5yhM1mUm4p5tRcY4Qf"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhMMA5yhM1mUm4p5tRcY4Qf/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - Partial Authorization","summary":"Transfer - Partial Authorization","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Partial Authorization"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Recurring or Unscheduled":{"value":{"id":"TRgQBFEUahEyLZ6zvu3hrqNJ","created_at":"2026-09-25T20:05:48.72Z","updated_at":"2026-09-25T20:05:48.72Z","3d_secure_session":null,"additional_buyer_charges":{"convenience_amount":150,"surcharge_amount":0,"rent_surcharge_amount":0},"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"321xyz","customs_duty_amount":10,"destination_country_code":null,"destination_postal_code":null,"discount_amount":100,"invoice_reference_number":null,"order_date":null,"sales_tax":null,"sales_tax_finix_generated":200,"ship_from_postal_code":null,"shipping_amount":100,"tax_exempt":false,"item_data":[{"cost_per_unit":500,"item_description":"printing paper","item_discount_amount":100,"merchant_product_code":"1149611","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"BX","commodity_code":"175-62-20","sales_tax_amount":100,"sales_tax_rate":0.25},{"cost_per_unit":500,"item_description":"printing ink","item_discount_amount":0,"merchant_product_code":"2149612","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"CTN","commodity_code":"207-72-54","sales_tax_amount":100,"sales_tax_rate":0.25}]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":1000,"amount_requested":1000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FP9F2KEnY4wt1XjFvhLBJVjb","idempotency_id":null,"ip_address_details":null,"merchant":"MUe17jKSrfPetoeiJQzzjmA2","merchant_identity":"ID6NvZy42D7PChZL8GKKD87F","messages":[],"network_details":{"brand":"VISA","authorization_code":"824912","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:49.20Z","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":["split_transfer_gQSpMGjxZRQ452uTarEZZ4","split_transfer_gQSr5EaDoRwr4A7E8EBPzH"],"state":"SUCCEEDED","statement_descriptor":"FLX*FLEX GYM","subtype":"API","supplemental_fee":null,"tags":{"tip":"50"},"third_party_details":null,"tip_amount":null,"trace_id":"2c32aa3f-cd7a-4b44-9b53-56af75957d85","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6NvZy42D7PChZL8GKKD87F"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRgQBFEUahEyLZ6zvu3hrqNJ"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FP9F2KEnY4wt1XjFvhLBJVjb"}}},"key":"Transfer - Recurring or Unscheduled","summary":"Transfer - Recurring or Unscheduled","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Recurring or Unscheduled"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Rent Surcharge":{"value":{"id":"TRhT38JgT5tw3Zy5QNA1SXTZ","created_at":"2026-09-25T20:06:02.87Z","updated_at":"2026-09-25T20:06:02.87Z","3d_secure_session":null,"additional_buyer_charges":{"convenience_amount":0,"surcharge_amount":0,"rent_surcharge_amount":1000},"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":1001000,"amount_requested":1001000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":{"brand":"VISA","authorization_code":"213570","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:06:03.25Z","raw":null,"ready_to_settle_at":"2026-09-26T20:06:02.87Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"4acef8ec-cbfc-414e-a5ec-eee6834da140","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhT38JgT5tw3Zy5QNA1SXTZ"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhT38JgT5tw3Zy5QNA1SXTZ/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhT38JgT5tw3Zy5QNA1SXTZ/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhT38JgT5tw3Zy5QNA1SXTZ"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhT38JgT5tw3Zy5QNA1SXTZ/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - Rent Surcharge","summary":"Transfer - Rent Surcharge","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Rent Surcharge"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Split Transaction":{"value":{"id":"TRhXDYSYqqRXxUQc6X1d4EW9","created_at":"2026-09-25T20:06:03.96Z","updated_at":"2026-09-25T20:06:03.96Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":1000,"amount_requested":1000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:06:04.39Z","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":"PI5benj4eVhCL4ALMv6SFxJG","split_transfers":["split_transfer_hXQKj2XHpuCYpv28wFBCkp","split_transfer_hXQLzkbV8j2GwN76pmyhDZ","split_transfer_hXQLW9Vy52QmS2wDpffKyd"],"state":"PENDING","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"e0c6b87f-017e-442c-97d5-2704b21bcd60","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhXDYSYqqRXxUQc6X1d4EW9"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhXDYSYqqRXxUQc6X1d4EW9/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhXDYSYqqRXxUQc6X1d4EW9/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhXDYSYqqRXxUQc6X1d4EW9"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhXDYSYqqRXxUQc6X1d4EW9/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI5benj4eVhCL4ALMv6SFxJG"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer - Split Transaction","summary":"Transfer - Split Transaction","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Split Transaction"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Surcharge":{"value":{"id":"TRrdTfkfvBAxWC7dCRfgKETT","created_at":"2025-11-10T16:32:07.18Z","updated_at":"2025-11-10T16:32:07.18Z","additional_buyer_charges":{"convenience_amount":0,"surcharge_amount":700,"rent_surcharge_amount":0},"additional_healthcare_data":null,"additional_purchase_data":null,"address_verification":null,"amount":10000,"amount_requested":10000,"application":"APgPDQrLD52TYvqazjHJJchM","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPvCQUcnsueN3Bc3zR1qCBG8","idempotency_id":null,"ip_address_details":null,"merchant":"MU3PLsrxmHcKRKhSoHDJ2FPP","merchant_identity":"IDjGTCVZzVCksPLtj63EJmSZ","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":"PImn9EAtceoUcBoXG2n73LY9","split_transfers":[],"state":"SUCCEEDED","statement_descriptor":"FNX*CURRENT-PAYMENT","subtype":"API","supplemental_fee":null,"tags":{},"tip_amount":null,"trace_id":"71855e3c-9d7e-44c4-8693-3f0b2c3b9cbf","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjGTCVZzVCksPLtj63EJmSZ"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRrdTfkfvBAxWC7dCRfgKETT"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRrdTfkfvBAxWC7dCRfgKETT/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImn9EAtceoUcBoXG2n73LY9"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPvCQUcnsueN3Bc3zR1qCBG8"}}},"key":"Transfer - Surcharge","summary":"Transfer - Surcharge","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Surcharge"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Card":{"value":{"id":"TRhJdBnKpQsRmXvWyLzGcFUm","created_at":"2025-08-14T21:45:12.98Z","updated_at":"2025-08-14T21:45:12.98Z","additional_buyer_charges":null,"additional_healthcare_data":null,"additional_purchase_data":null,"address_verification":null,"amount":15000,"amount_requested":15000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":"PIveyqg2bVkKo6SHsstxBSDc","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","funds_flow_type":"ME_TO_ME","idempotency_id":null,"merchant":"MUuNdhs7uVYcjocWugeBbpRo","merchant_identity":"IDbPrApp2adDVqG4QQzoo58E","messages":[],"network_details":{},"operation_key":"PUSH_TO_CARD","parent_transfer":null,"parent_transfer_trace_id":null,"pull_transfer_id":"TR3vKfwCuXmLqPsDYbGYn4NUm","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"SUCCEEDED","statement_descriptor":null,"subtype":"API","supplemental_fee":null,"tags":{},"tip_amount":null,"trace_id":"91850fg7-3129-6216-c5hh-h795f9h5g569","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhJdBnKpQsRmXvWyLzGcFUm"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDbPrApp2adDVqG4QQzoo58E"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhJdBnKpQsRmXvWyLzGcFUm/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhJdBnKpQsRmXvWyLzGcFUm/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRhJdBnKpQsRmXvWyLzGcFUm"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhJdBnKpQsRmXvWyLzGcFUm/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIveyqg2bVkKo6SHsstxBSDc"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Me to Me Payout - Card","summary":"Transfer - Me to Me Payout - Card","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Card"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank":{"value":{"id":"TRkPvQmNxBsHdWyCjLzGaFRp","created_at":"2025-08-14T20:59:09.39Z","updated_at":"2025-08-14T20:59:09.39Z","additional_buyer_charges":null,"additional_healthcare_data":null,"additional_purchase_data":null,"address_verification":null,"amount":15000,"amount_requested":15000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":"PI95jTbyzcdjhWsgFEK6vqSU","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","funds_flow_type":"ME_TO_ME","idempotency_id":null,"merchant":"MU2bESfmfedhA2SjcymNvSAX","merchant_identity":"IDA3M8ueFuXaJex7N6jcAR9","messages":[],"network_details":{},"operation_key":"PUSH_TO_ACH","parent_transfer":null,"parent_transfer_trace_id":null,"pull_transfer_id":"TR4mNhCuXkAqRsDYbJYnBCDe","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"PENDING","statement_descriptor":null,"subtype":"API","supplemental_fee":null,"tags":{},"tip_amount":null,"trace_id":"562e155d-521e-65hf-d4c6-fg8d9h5f4469","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkPvQmNxBsHdWyCjLzGaFRp"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkPvQmNxBsHdWyCjLzGaFRp/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkPvQmNxBsHdWyCjLzGaFRp/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRkPvQmNxBsHdWyCjLzGaFRp"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkPvQmNxBsHdWyCjLzGaFRp/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Me to Me Payout - Bank","summary":"Transfer - Me to Me Payout - Bank","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank"},"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day":{"value":{"id":"TRnRtQmNxBsHdWyCjLzGaFSd","created_at":"2025-08-15T13:37:30.38Z","updated_at":"2025-08-15T13:37:30.38Z","additional_buyer_charges":null,"additional_healthcare_data":null,"additional_purchase_data":null,"address_verification":null,"amount":15000,"amount_requested":15000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","destination":"PI95jTbyzcdjhWsgFEK6vqSU","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","funds_flow_type":"ME_TO_ME","idempotency_id":null,"merchant":"MU2bESfmfedhA2SjcymNvSAX","merchant_identity":"IDA3M8ueFuXaJex7N6jcAR9","messages":[],"network_details":null,"operation_key":"PUSH_TO_SAME_DAY_ACH","parent_transfer":null,"parent_transfer_trace_id":null,"pull_transfer_id":"TR5sDhCuXkAqRsEYbJYnSDFg","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"PENDING","statement_descriptor":null,"subtype":"API","supplemental_fee":null,"tags":{},"tip_amount":null,"trace_id":"f9h1626g-60gc-6e00-0123-020hf4eh9ccf","type":"CREDIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnRtQmNxBsHdWyCjLzGaFSd"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDA3M8ueFuXaJex7N6jcAR9"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnRtQmNxBsHdWyCjLzGaFSd/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnRtQmNxBsHdWyCjLzGaFSd/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRnRtQmNxBsHdWyCjLzGaFSd"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnRtQmNxBsHdWyCjLzGaFSd/disputes"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI95jTbyzcdjhWsgFEK6vqSU"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Transfer - Me to Me Payout - Bank - Same Day","summary":"Transfer - Me to Me Payout - Bank - Same Day","id":"paths/~1transfers/post/responses/201/content/application~1json/examples/Transfer - Me to Me Payout - Bank - Same Day"},"paths/~1transfers/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1transfers/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1transfers/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1transfers/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1transfers/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1transfers/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1transfers/post/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"4516d21444c951ba","message":"merchant not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1transfers/post/responses/404/content/application~1json/examples/Not found"},"paths/~1transfers/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1transfers/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfers/post/responses/422/content/application~1json/examples/Source instrument not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"aba39d158fff12a7","message":"source instrument is not valid or found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Source instrument not found","summary":"Source instrument not found","id":"paths/~1transfers/post/responses/422/content/application~1json/examples/Source instrument not found"},"paths/~1transfers/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"9a0d5f31c8b47e26","message":"3d_secure_authentication and 3d_secure_session_9hK2mNp4T761RBv8qwLDYc cannot be used together.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"3d_secure_authentication and 3d_secure_session used together","summary":"3d_secure_authentication and 3d_secure_session used together","id":"paths/~1transfers/post/responses/422/content/application~1json/examples/3d_secure_authentication and 3d_secure_session used together"},"paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"1f6b8c02ae934d57","message":"3d_secure_session_9hK2mNp4T761RBv8qwLDYc is associated with a different Payment Instrument than the source provided.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"3D Secure Session belongs to a different Payment Instrument","summary":"3D Secure Session belongs to a different Payment Instrument","id":"paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session belongs to a different Payment Instrument"},"paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session already used":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"4c73e9a15d08b2f6","message":"A transaction with 3d_secure_session_9hK2mNp4T761RBv8qwLDYc has already been submitted.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"3D Secure Session already used","summary":"3D Secure Session already used","id":"paths/~1transfers/post/responses/422/content/application~1json/examples/3D Secure Session already used"},"paths/~1transfers/get/responses/200/content/application~1json/examples/List of Transfers":{"value":{"_embedded":{"transfers":[{"id":"TReUN4YvkrnDWizMW7QfKNS9","created_at":"2025-03-26T16:14:48.66Z","updated_at":"2025-03-26T16:14:48.66Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":19900,"amount_requested":19900,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":"0c08b8cb-efb6-4c02-9dcb-323645bb7a0b","ip_address_details":null,"merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","merchant_identity":"IDgCoio3FfaMSKPNM35atXPU","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":"2025-03-27T16:14:49.20Z","receipt_last_printed_at":null,"security_code_verification":null,"source":"PImXAVgkKVshKWWHUk4xXbve","split_transfers":null,"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{"subscription_id":"subscription_cmvX6f7CPp2vt1byGwQWa"},"third_party_details":null,"tip_amount":null,"trace_id":"a141e46d-610f-48b4-af5e-0bb47293f2ae","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TReUN4YvkrnDWizMW7QfKNS9"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDgCoio3FfaMSKPNM35atXPU"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TReUN4YvkrnDWizMW7QfKNS9/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TReUN4YvkrnDWizMW7QfKNS9/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TReUN4YvkrnDWizMW7QfKNS9"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TReUN4YvkrnDWizMW7QfKNS9/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImXAVgkKVshKWWHUk4xXbve"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},{"id":"TR5u8LEE8RE6FP59xaWEEbb4","created_at":"2025-03-25T17:46:55.22Z","updated_at":"2025-03-25T17:46:55.22Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":1000000,"amount_requested":1000000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":"1aaa2ce2-3e6b-4bc1-a2c9-d0ad9187e9dc","ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":"2025-03-26T17:46:55.79Z","receipt_last_printed_at":null,"security_code_verification":null,"source":"PI2wttj9ASQ1Fx5rosQTQmq3","split_transfers":null,"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{"subscription_id":"subscription_cjwzLAvPeSFex5ANehVMq"},"third_party_details":null,"tip_amount":null,"trace_id":"f82e9eba-26fa-4481-b367-a73dd113a61e","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TR5u8LEE8RE6FP59xaWEEbb4"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TR5u8LEE8RE6FP59xaWEEbb4/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TR5u8LEE8RE6FP59xaWEEbb4/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TR5u8LEE8RE6FP59xaWEEbb4"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TR5u8LEE8RE6FP59xaWEEbb4/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI2wttj9ASQ1Fx5rosQTQmq3"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},{"id":"TRkzNB7d83DpeN9JVpX9YUqp","created_at":"2025-03-24T18:55:56.97Z","updated_at":"2025-03-24T18:55:56.97Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":19900,"amount_requested":19900,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":"7167e61b-19d4-4fb0-89ee-71e5c33cbf2d","ip_address_details":null,"merchant":"MUcgYZswyRfqSSbvMsxuaHxZ","merchant_identity":"IDgCoio3FfaMSKPNM35atXPU","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":"2025-03-25T18:55:57.59Z","receipt_last_printed_at":null,"security_code_verification":null,"source":"PImXAVgkKVshKWWHUk4xXbve","split_transfers":null,"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{"subscription_id":"subscription_cmsnL75xHWykUgmdqAbmW"},"third_party_details":null,"tip_amount":null,"trace_id":"2e8e5614-1568-40e4-b658-e589f197f08b","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkzNB7d83DpeN9JVpX9YUqp"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDgCoio3FfaMSKPNM35atXPU"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkzNB7d83DpeN9JVpX9YUqp/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkzNB7d83DpeN9JVpX9YUqp/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRkzNB7d83DpeN9JVpX9YUqp"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRkzNB7d83DpeN9JVpX9YUqp/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PImXAVgkKVshKWWHUk4xXbve"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers?limit=3&state=SUCCEEDED&type=DEBIT&instrument_issuer_country=USA&instrument_type=PAYMENT_CARD"},"next":{"href":"https://finix.sandbox-payments-api.com/transfers?limit=3&state=SUCCEEDED&type=DEBIT&instrument_issuer_country=USA&instrument_type=PAYMENT_CARD&after_cursor=TRkzNB7d83DpeN9JVpX9YUqp"}},"page":{"limit":3,"next_cursor":"TRkzNB7d83DpeN9JVpX9YUqp"}},"key":"List of Transfers","summary":"List of Transfers","id":"paths/~1transfers/get/responses/200/content/application~1json/examples/List of Transfers"},"paths/~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1transfers/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1transfers/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1transfers/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1transfers/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1transfers/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1transfers/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1transfers~1{transfer_id}/get/responses/200/content/application~1json/examples/Transfer":{"value":{"id":"TRgQBFEUahEyLZ6zvu3hrqNJ","created_at":"2026-09-25T20:05:48.72Z","updated_at":"2026-09-25T20:05:48.72Z","3d_secure_session":null,"additional_buyer_charges":{"convenience_amount":150,"surcharge_amount":0,"rent_surcharge_amount":0},"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":{"customer_reference_number":"321xyz","customs_duty_amount":10,"destination_country_code":null,"destination_postal_code":null,"discount_amount":100,"invoice_reference_number":null,"order_date":null,"sales_tax":null,"sales_tax_finix_generated":200,"ship_from_postal_code":null,"shipping_amount":100,"tax_exempt":false,"item_data":[{"cost_per_unit":500,"item_description":"printing paper","item_discount_amount":100,"merchant_product_code":"1149611","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"BX","commodity_code":"175-62-20","sales_tax_amount":100,"sales_tax_rate":0.25},{"cost_per_unit":500,"item_description":"printing ink","item_discount_amount":0,"merchant_product_code":"2149612","quantity":1,"amount_excluding_sales_tax":400,"amount_including_sales_tax":500,"unit_of_measure":"CTN","commodity_code":"207-72-54","sales_tax_amount":100,"sales_tax_rate":0.25}]},"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":1000,"amount_requested":1000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FP9F2KEnY4wt1XjFvhLBJVjb","idempotency_id":null,"ip_address_details":null,"merchant":"MUe17jKSrfPetoeiJQzzjmA2","merchant_identity":"ID6NvZy42D7PChZL8GKKD87F","messages":[],"network_details":{"brand":"VISA","authorization_code":"824912","acquirer_reference_number":null},"operation_key":"CARD_NOT_PRESENT_SALE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":"2026-09-25T20:05:49.20Z","raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PI6iQcTtJNCS8GZAVKYi5Ueb","split_transfers":["split_transfer_gQSpMGjxZRQ452uTarEZZ4","split_transfer_gQSr5EaDoRwr4A7E8EBPzH"],"state":"SUCCEEDED","statement_descriptor":"FLX*FLEX GYM","subtype":"API","supplemental_fee":null,"tags":{"tip":"50"},"third_party_details":null,"tip_amount":null,"trace_id":"2c32aa3f-cd7a-4b44-9b53-56af75957d85","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6NvZy42D7PChZL8GKKD87F"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRgQBFEUahEyLZ6zvu3hrqNJ"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRgQBFEUahEyLZ6zvu3hrqNJ/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FP9F2KEnY4wt1XjFvhLBJVjb"}}},"key":"Transfer","summary":"Transfer","id":"paths/~1transfers~1{transfer_id}/get/responses/200/content/application~1json/examples/Transfer"},"paths/~1transfers~1{transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1transfers~1{transfer_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1transfers~1{transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1transfers~1{transfer_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1transfers~1{transfer_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"TRnErBfrHLgdAi3BqAkWLN27 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1transfers~1{transfer_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1transfers~1{transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1transfers~1{transfer_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfers~1{transfer_id}/put/requestBody/content/application~1json/examples/Update a Transfer":{"value":{"tags":{"test":"sale"}},"key":"Update a Transfer","summary":"Update a Transfer","id":"paths/~1transfers~1{transfer_id}/put/requestBody/content/application~1json/examples/Update a Transfer"},"paths/~1transfers~1{transfer_id}/put/responses/200/content/application~1json/examples/Transfer":{"value":{"id":"TRrC36MYGH6n67wRfYs8w8RK","created_at":"2026-05-26T21:12:22.37Z","updated_at":"2026-09-25T20:06:35.02Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":"POSTAL_CODE_AND_STREET_MATCH","amount":100,"amount_requested":100,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":null,"externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_CAPTURE","parent_transfer":null,"parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":"2026-05-27T21:12:22.37Z","receipt_last_printed_at":null,"security_code_verification":"MATCHED","source":"PIkxmtueemLD6dN9ZoWGHT44","split_transfers":["split_transfer_jyjEMRZNKpftJVNpXMoxfZ","split_transfer_jyjSy2p9RDTk5b4DE7Kztw"],"state":"SUCCEEDED","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{"test":"sale"},"third_party_details":null,"tip_amount":null,"trace_id":"0e2c5999-8c67-4f11-860d-b29728269076","type":"DEBIT","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRrC36MYGH6n67wRfYs8w8RK"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRrC36MYGH6n67wRfYs8w8RK/payment_instruments"},"reversals":{"href":"https://finix.sandbox-payments-api.com/transfers/TRrC36MYGH6n67wRfYs8w8RK/reversals"},"fees":{"href":"https://finix.sandbox-payments-api.com/fees?linked_to=TRrC36MYGH6n67wRfYs8w8RK"},"disputes":{"href":"https://finix.sandbox-payments-api.com/transfers/TRrC36MYGH6n67wRfYs8w8RK/disputes"},"source":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Transfer","summary":"Transfer","id":"paths/~1transfers~1{transfer_id}/put/responses/200/content/application~1json/examples/Transfer"},"paths/~1transfers~1{transfer_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1transfers~1{transfer_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1transfers~1{transfer_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1transfers~1{transfer_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1transfers~1{transfer_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1transfers~1{transfer_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1transfers~1{transfer_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"TRnErBfrHLgdAi3BqAkWLN27 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1transfers~1{transfer_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1transfers~1{transfer_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1transfers~1{transfer_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer":{"value":{"refund_amount":1000},"key":"Refund Transfer","summary":"Refund Transfer","id":"paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer"},"paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer - Split Transaction":{"value":{"refund_amount":1000,"split_transfers":[{"amount":600,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","tags":{"key":"value"}},{"amount":300,"fee":100,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq"},{"amount":100,"merchant":"MUcgYZswyRfqSSbvMsxuaHxZ"}]},"key":"Refund Transfer - Split Transaction","summary":"Refund Transfer - Split Transaction","id":"paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Transfer - Split Transaction"},"paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Card Present Transfer - Referenced":{"value":{"device":"DVhCtTEMVHnDPFMh2KQLrFSi","refund_amount":150},"key":"Refund Card Present Transfer - Referenced","summary":"Refund Card Present Transfer - Referenced","id":"paths/~1transfers~1{transfer_id}~1reversals/post/requestBody/content/application~1json/examples/Refund Card Present Transfer - Referenced"},"paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer":{"value":{"id":"TRhop5SzZD5AbRGz6HC6qB5w","created_at":"2026-09-25T20:36:25.76Z","updated_at":"2026-09-25T20:36:25.79Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":1000,"amount_requested":1000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":"PI6iQcTtJNCS8GZAVKYi5Ueb","expires_at":"2026-11-09T20:36:25.76Z","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_REFUND","parent_transfer":"TRqvNLUdn3aPmdwLMSKs3Gxz","parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"PENDING","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"9fc0c015-0d97-49f1-93a6-b845d4e50c01","type":"REVERSAL","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhop5SzZD5AbRGz6HC6qB5w"},"parent":{"href":"https://finix.sandbox-payments-api.com/transfers/TRqvNLUdn3aPmdwLMSKs3Gxz"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI6iQcTtJNCS8GZAVKYi5Ueb"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhop5SzZD5AbRGz6HC6qB5w/payment_instruments"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Refund Transfer","summary":"Refund Transfer","id":"paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer"},"paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer - Split Transaction":{"value":{"id":"TRfE8FguNTKJfCUcdtUN5RFT","created_at":"2026-09-25T20:36:27.13Z","updated_at":"2026-09-25T20:36:27.20Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":1000,"amount_requested":1000,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":"PI5benj4eVhCL4ALMv6SFxJG","expires_at":"2026-11-09T20:36:27.13Z","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPuizPqrhzYLbmJm88u7aqfj","idempotency_id":null,"ip_address_details":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_REFUND","parent_transfer":"TRqCS1yjNp3XmYRKrKPHcDBK","parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":["split_transfer_qGPE2kTNrTjUqnquew66Kf","split_transfer_qGPF8tHAXe3xhhUBWr4oWy","split_transfer_qGPFuiseTWRcBtxk76DBg5"],"state":"PENDING","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"9286fa1a-8f78-4038-81ac-d8ad66dc2f55","type":"REVERSAL","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRfE8FguNTKJfCUcdtUN5RFT"},"parent":{"href":"https://finix.sandbox-payments-api.com/transfers/TRqCS1yjNp3XmYRKrKPHcDBK"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI5benj4eVhCL4ALMv6SFxJG"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/ID6UfSm1d4WPiWgLYmbyeo3H"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TRfE8FguNTKJfCUcdtUN5RFT/payment_instruments"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPuizPqrhzYLbmJm88u7aqfj"}}},"key":"Refund Transfer - Split Transaction","summary":"Refund Transfer - Split Transaction","id":"paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Transfer - Split Transaction"},"paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Card Present Transfer - Referenced":{"value":{"id":"TR7PYuTpCU3AtLSgvSobjmGg","created_at":"2026-09-28T20:31:08.64Z","updated_at":"2026-09-28T20:31:08.69Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":150,"amount_requested":150,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":"PI2zjrcxkiPYEokwQPq2G58z","device":"DVhCtTEMVHnDPFMh2KQLrFSi","expires_at":"2026-11-12T20:31:08.64Z","externally_funded":"UNKNOWN","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MUmFY9PWbqJPGtQEN7RXdFAb","merchant_identity":"IDvEVPqD9rnfLCAGnLJphyGT","messages":[],"network_details":null,"operation_key":"CARD_PRESENT_REFUND","parent_transfer":"TRhBbRpGifWm9U8fCaKVVAZo","parent_transfer_trace_id":null,"processed_at":null,"raw":null,"ready_to_settle_at":null,"receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":[],"state":"PENDING","statement_descriptor":"FLX*FINIX FLOWERS","subtype":"API","supplemental_fee":null,"tags":{},"third_party_details":null,"tip_amount":null,"trace_id":"253a57c6-a449-427c-9732-33655040b819","type":"REVERSAL","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TR7PYuTpCU3AtLSgvSobjmGg"},"parent":{"href":"https://finix.sandbox-payments-api.com/transfers/TRhBbRpGifWm9U8fCaKVVAZo"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PI2zjrcxkiPYEokwQPq2G58z"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDvEVPqD9rnfLCAGnLJphyGT"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TR7PYuTpCU3AtLSgvSobjmGg/payment_instruments"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}},"key":"Refund Card Present Transfer - Referenced","summary":"Refund Card Present Transfer - Referenced","id":"paths/~1transfers~1{transfer_id}~1reversals/post/responses/201/content/application~1json/examples/Refund Card Present Transfer - Referenced"},"paths/~1transfers~1{transfer_id}~1reversals/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1transfers~1{transfer_id}~1reversals/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1transfers~1{transfer_id}~1reversals/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1transfers~1{transfer_id}~1reversals/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1transfers~1{transfer_id}~1reversals/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1transfers~1{transfer_id}~1reversals/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1transfers~1{transfer_id}~1reversals/post/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"c728665f42f7aef9","message":"TRnErBfrHLgdAi3BqAkWLx27 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLx27/reversals"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1transfers~1{transfer_id}~1reversals/post/responses/404/content/application~1json/examples/Not found"},"paths/~1transfers~1{transfer_id}~1reversals/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1transfers~1{transfer_id}~1reversals/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfers~1{transfer_id}~1reversals/get/responses/200/content/application~1json/examples/List of Reversed Transfers":{"value":{"_embedded":{"transfers":[{"id":"TR2KU7cWTnzb4hmfZxc1fvuv","created_at":"2025-09-12T01:01:59.41Z","updated_at":"2025-09-12T01:02:03.28Z","3d_secure_session":null,"additional_buyer_charges":null,"additional_healthcare_data":null,"additional_lodging_data":null,"additional_motor_vehicle_rental_data":null,"additional_purchase_data":null,"address_verification":null,"amount":100,"amount_requested":100,"application":"APc9vhYcPsRuTSpKD9KpMtPe","created_via":"UNKNOWN","currency":"USD","destination":"PIkxmtueemLD6dN9ZoWGHT44","externally_funded":"FALSE","failure_code":null,"failure_message":null,"fee":0,"fee_profile":"FPmtT4MYmiAs1qjLjneQmk4d","idempotency_id":null,"ip_address_details":null,"merchant":"MU7noQ1wdgdAeAfymw2rfBMq","merchant_identity":"IDjvxGeXBLKH1V9YnWm1CS4n","messages":[],"network_details":null,"operation_key":"CARD_NOT_PRESENT_REFUND","parent_transfer":"TRnErBfrHLgdAi3BqAkWLN27","parent_transfer_trace_id":"27aad359-b747-4159-9f01-bcaa77245d71","processed_at":null,"raw":null,"ready_to_settle_at":"2025-09-13T01:02:03.31Z","receipt_last_printed_at":null,"security_code_verification":null,"source":null,"split_transfers":null,"state":"SUCCEEDED","statement_descriptor":"FLX*FLEX","subtype":"API","supplemental_fee":null,"tags":{"test":"Refund"},"third_party_details":null,"tip_amount":null,"trace_id":"25ae59b0-fb0e-4666-a8c4-710bb37b4be7","type":"REVERSAL","_links":{"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TR2KU7cWTnzb4hmfZxc1fvuv"},"parent":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27"},"destination":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIkxmtueemLD6dN9ZoWGHT44"},"merchant_identity":{"href":"https://finix.sandbox-payments-api.com/identities/IDjvxGeXBLKH1V9YnWm1CS4n"},"payment_instruments":{"href":"https://finix.sandbox-payments-api.com/transfers/TR2KU7cWTnzb4hmfZxc1fvuv/payment_instruments"},"fee_profile":{"href":"https://finix.sandbox-payments-api.com/fee_profiles/FPmtT4MYmiAs1qjLjneQmk4d"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"},"next":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals?after_cursor=TR2KU7cWTnzb4hmfZxc1fvuv"},"parent":{"href":"https://finix.sandbox-payments-api.com/transfers/af6df4d9-ff5d-42dd-bfc8-12feaf8db358"}},"page":{"limit":100,"next_cursor":"TR2KU7cWTnzb4hmfZxc1fvuv"},"unreversed_amount":0},"key":"List of Reversed Transfers","summary":"List of Reversed Transfers","id":"paths/~1transfers~1{transfer_id}~1reversals/get/responses/200/content/application~1json/examples/List of Reversed Transfers"},"paths/~1transfers~1{transfer_id}~1reversals/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1transfers~1{transfer_id}~1reversals/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1transfers~1{transfer_id}~1reversals/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1transfers~1{transfer_id}~1reversals/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1transfers~1{transfer_id}~1reversals/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"e3919f0300f7951c","message":"TRvU2qRMSYGnJY6dcdXehJqd not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRvU2qRMSYGnJY6dcdXehJqd/reversals"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1transfers~1{transfer_id}~1reversals/get/responses/404/content/application~1json/examples/Not found"},"paths/~1transfers~1{transfer_id}~1reversals/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1transfers~1{transfer_id}~1reversals/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfers~1{transfer_id}~1reversals/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfers/TRnErBfrHLgdAi3BqAkWLN27/reversals"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1transfers~1{transfer_id}~1reversals/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1users/get/responses/200/content/application~1json/examples/List of Users":{"value":{"_embedded":{"users":[{"id":"USarwmxQ4Mxv6trtYit8bVhy","created_at":"2024-11-14T22:25:05.60Z","updated_at":"2026-09-25T20:06:35.88Z","created_by":"US7712r2cfMvGR8H3R9Di6c3","email":null,"enabled":false,"first_name":null,"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","last_name":null,"last_used_date":null,"password":null,"role":"ROLE_PARTNER","tags":{"name":"Default user","card_name":"New Employee"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USarwmxQ4Mxv6trtYit8bVhy"},"applications":{"href":"https://finix.sandbox-payments-api.com/applications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"USam57AgDDm1QXgZDGs9hmZP","created_at":"2024-12-03T15:43:09.00Z","updated_at":"2026-09-01T16:29:04.16Z","created_by":"USyCRfdUqbCexG2epWVJkuK","email":"oscar@finixpayments.com","enabled":true,"first_name":null,"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","last_name":null,"last_used_date":"2026-09-01","password":null,"role":"ROLE_PARTNER","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USam57AgDDm1QXgZDGs9hmZP"},"applications":{"href":"https://finix.sandbox-payments-api.com/applications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"UScxTTYxJNAmRsZiWGCaDhNU","created_at":"2024-12-03T15:43:38.95Z","updated_at":"2026-09-23T17:39:45.72Z","created_by":"USyCRfdUqbCexG2epWVJkuK","email":"contractor.mark.w@finix.com","enabled":true,"first_name":null,"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","last_name":null,"last_used_date":"2026-09-23","password":null,"role":"ROLE_PARTNER","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/UScxTTYxJNAmRsZiWGCaDhNU"},"applications":{"href":"https://finix.sandbox-payments-api.com/applications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users?offset=0&limit=3&sort=created_at,desc&sort=id,desc"},"next":{"href":"https://finix.sandbox-payments-api.com/users?offset=3&limit=3&sort=created_at,desc&sort=id,desc"},"last":{"href":"https://finix.sandbox-payments-api.com/users?offset=165&limit=3&sort=created_at,desc&sort=id,desc"}},"page":{"offset":0,"limit":3,"count":167}},"key":"List of Users","summary":"List of Users","id":"paths/~1users/get/responses/200/content/application~1json/examples/List of Users"},"paths/~1users/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1users/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1users/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1users/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1users/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1users/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1users/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1users/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/User":{"value":{"id":"USfQxMmbRPkdXYFqGQefC5v4","created_at":"2025-02-20T00:41:49.04Z","updated_at":"2025-02-21T00:56:49.67Z","created_by":"US7iDiPbpRJ5pzT6HuXD5Yv3","email":null,"enabled":true,"first_name":"DVae7HFLS7BXNaFpKhdH1K6x","identity":"ID6UfSm1d4WPiWgLYmbyeo3H","last_name":"CARD PRESENT DEVICE CREDENTIALS","last_used_date":"2025-02-21","password":null,"role":"ROLE_MERCHANT","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USfQxMmbRPkdXYFqGQefC5v4"},"applications":{"href":"https://finix.sandbox-payments-api.com/applications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"User","summary":"User","id":"paths/~1users~1{user_id}/get/responses/200/content/application~1json/examples/User"},"paths/~1users~1{user_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1users~1{user_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1users~1{user_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1users~1{user_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1users~1{user_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"USvVu9MXHz7hVzwDXwbx3UCL was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1users~1{user_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1users~1{user_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1users~1{user_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Update Tags":{"value":{"tags":{"card_name":"New Employee"}},"key":"Update Tags","summary":"Update Tags","id":"paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Update Tags"},"paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Disable User":{"value":{"enabled":false},"key":"Disable User","summary":"Disable User","id":"paths/~1users~1{user_id}/put/requestBody/content/application~1json/examples/Disable User"},"paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Update Tags":{"value":{"id":"USarwmxQ4Mxv6trtYit8bVhy","created_at":"2024-11-14T22:25:05.60Z","updated_at":"2026-09-25T20:06:35.88Z","created_by":"US7712r2cfMvGR8H3R9Di6c3","email":null,"enabled":true,"first_name":null,"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","last_name":null,"last_used_date":null,"password":null,"role":"ROLE_PARTNER","tags":{"name":"Default user","card_name":"New Employee"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USarwmxQ4Mxv6trtYit8bVhy"},"applications":{"href":"https://finix.sandbox-payments-api.com/applications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Update Tags","summary":"Update Tags","id":"paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Update Tags"},"paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Disable User":{"value":{"id":"USarwmxQ4Mxv6trtYit8bVhy","created_at":"2024-11-14T22:25:05.60Z","updated_at":"2026-09-25T20:06:35.58Z","created_by":"US7712r2cfMvGR8H3R9Di6c3","email":null,"enabled":false,"first_name":null,"identity":"IDjvxGeXBLKH1V9YnWm1CS4n","last_name":null,"last_used_date":null,"password":null,"role":"ROLE_PARTNER","tags":{"name":"Default user","card_name":"New Employee"},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USarwmxQ4Mxv6trtYit8bVhy"},"applications":{"href":"https://finix.sandbox-payments-api.com/applications"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Disable User","summary":"Disable User","id":"paths/~1users~1{user_id}/put/responses/200/content/application~1json/examples/Disable User"},"paths/~1users~1{user_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1users~1{user_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1users~1{user_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1users~1{user_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1users~1{user_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1users~1{user_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1users~1{user_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"USvVu9MXHz7hVzwDXwbx3UCL was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1users~1{user_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1users~1{user_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/users/USvVu9MXHz7hVzwDXwbx3UCL"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1users~1{user_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1merchants~1{merchant_id}~1verifications/get/responses/200/content/application~1json/examples/Merchant Verifications List":{"value":{"_embedded":{"verifications":[{"id":"VIsmg3o9ZZhTJuQfsg4JkPgv","created_at":"2026-04-08T23:47:06.36Z","updated_at":"2026-04-08T23:48:04.40Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":"MUwfZPNW3r4EqLMzwgr6txw4","merchant_identity":"IDhC29dXMAkbmr1aBpS91Hpx","messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":null,"payment_instrument_verification_details":{"billing_currency":null,"card_type":null,"issuer_country":null,"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_cross_border":null,"push_to_card_domestic":null},"processor":"DUMMY_V1","raw":"RawDummyMerchantUnderwriteResult","reverification_reason":{"review_type":"UNKNOWN","initiated_by":"MANUAL","reason_description":null},"state":"SUCCEEDED","sub_type":null,"tags":{},"trace_id":"7e92daf9-5357-4bf7-9908-10b5f77e1096","type":"MERCHANT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VIsmg3o9ZZhTJuQfsg4JkPgv"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}},{"id":"VIfg2PYfT83hXgRreFa93H7z","created_at":"2025-09-16T04:29:11.82Z","updated_at":"2025-09-16T04:30:03.01Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":"MUwfZPNW3r4EqLMzwgr6txw4","merchant_identity":"IDhC29dXMAkbmr1aBpS91Hpx","messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":null,"payment_instrument_verification_details":{"billing_currency":null,"card_type":null,"issuer_country":null,"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_cross_border":null,"push_to_card_domestic":null},"processor":"DUMMY_V1","raw":"RawDummyMerchantUnderwriteResult","reverification_reason":{"review_type":null,"initiated_by":null,"reason_description":null},"state":"SUCCEEDED","sub_type":null,"tags":{},"trace_id":"2950c9f1-367d-4588-86a3-c78fdea878aa","type":"MERCHANT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VIfg2PYfT83hXgRreFa93H7z"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}},{"id":"VIdSi9taaQT15tWrBAcmnuoC","created_at":"2025-09-16T04:22:17.65Z","updated_at":"2025-09-16T04:23:01.97Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":"MUwfZPNW3r4EqLMzwgr6txw4","merchant_identity":"IDhC29dXMAkbmr1aBpS91Hpx","messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":null,"payment_instrument_verification_details":{"billing_currency":null,"card_type":null,"issuer_country":null,"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_cross_border":null,"push_to_card_domestic":null},"processor":"DUMMY_V1","raw":"RawDummyMerchantUnderwriteResult","reverification_reason":{"review_type":null,"initiated_by":null,"reason_description":null},"state":"SUCCEEDED","sub_type":null,"tags":{},"trace_id":"86966a68-f399-4517-acd7-d4b9bd90a093","type":"MERCHANT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VIdSi9taaQT15tWrBAcmnuoC"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications?limit=3&after_cursor=VIdSi9taaQT15tWrBAcmnuoC"}},"page":{"limit":3,"next_cursor":"VIdSi9taaQT15tWrBAcmnuoC"}},"key":"Merchant Verifications List","summary":"Merchant Verifications List","id":"paths/~1merchants~1{merchant_id}~1verifications/get/responses/200/content/application~1json/examples/Merchant Verifications List"},"paths/~1merchants~1{merchant_id}~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1merchants~1{merchant_id}~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1merchants~1{merchant_id}~1verifications/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1merchants~1{merchant_id}~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1merchants~1{merchant_id}~1verifications/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1merchants~1{merchant_id}~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1merchants~1{merchant_id}~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/merchants/MUwfZPNW3r4EqLMzwgr6txw4/verifications"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1merchants~1{merchant_id}~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1verifications/get/responses/200/content/application~1json/examples/List of Verifications":{"value":{"_embedded":{"verifications":[{"id":"VIh7waQM3RYJUGAbY1vsCis2","created_at":"2026-09-30T00:03:47.15Z","updated_at":"2026-09-30T00:03:47.16Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":"MUi8t3vZZszuYVYp6xZd3xXM","merchant_identity":"IDkkcpWZC4BH632gbtcvB52h","messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":null,"payment_instrument_verification_details":{"billing_currency":null,"card_type":null,"issuer_country":null,"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_cross_border":null,"push_to_card_domestic":null},"processor":"DUMMY_V1","raw":null,"reverification_reason":{"review_type":null,"initiated_by":null,"reason_description":null},"state":"PENDING","sub_type":null,"tags":{},"trace_id":"6744d9a3-61fd-4021-bcd4-f9636f26f86a","type":"MERCHANT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VIh7waQM3RYJUGAbY1vsCis2"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUi8t3vZZszuYVYp6xZd3xXM"}}},{"id":"VI92t6ZhDRybhbZpW6v4ADVg","created_at":"2026-09-30T00:02:21.93Z","updated_at":"2026-09-30T00:03:04.72Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":"MUfgUw9uKkWmxdcvBDU6MdKv","merchant_identity":"IDq9KcL6ER6oe5kUw9vk1QzK","messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":null,"payment_instrument_verification_details":{"billing_currency":null,"card_type":null,"issuer_country":null,"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_cross_border":null,"push_to_card_domestic":null},"processor":"DUMMY_V1","raw":"RawDummyMerchantUnderwriteResult","reverification_reason":{"review_type":null,"initiated_by":null,"reason_description":null},"state":"SUCCEEDED","sub_type":null,"tags":{},"trace_id":"294871c9-7df4-43d3-99e6-47862333b108","type":"MERCHANT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VI92t6ZhDRybhbZpW6v4ADVg"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUfgUw9uKkWmxdcvBDU6MdKv"}}},{"id":"VI2R9GbrxUTKDn6Tn5aa1h32","created_at":"2026-09-30T00:02:20.34Z","updated_at":"2026-09-30T00:03:04.92Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":"MUpzJZYa8bT46wmA7XaBX4L9","merchant_identity":"IDkemSfUrLX1tkZpgQWMJXZs","messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":null,"payment_instrument_verification_details":{"billing_currency":null,"card_type":null,"issuer_country":null,"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_cross_border":null,"push_to_card_domestic":null},"processor":"DUMMY_V1","raw":"RawDummyMerchantUnderwriteResult","reverification_reason":{"review_type":null,"initiated_by":null,"reason_description":null},"state":"SUCCEEDED","sub_type":null,"tags":{},"trace_id":"11de9578-a70e-44d7-a569-f1c5d839d857","type":"MERCHANT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VI2R9GbrxUTKDn6Tn5aa1h32"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUpzJZYa8bT46wmA7XaBX4L9"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/verifications?limit=3&after_cursor=VI2R9GbrxUTKDn6Tn5aa1h32"}},"page":{"limit":3,"next_cursor":"VI2R9GbrxUTKDn6Tn5aa1h32"}},"key":"List of Verifications","summary":"List of Verifications","id":"paths/~1verifications/get/responses/200/content/application~1json/examples/List of Verifications"},"paths/~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1verifications/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1verifications/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1verifications/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1verifications/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1verifications/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1verifications/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Payment Instrument":{"value":{"id":"VIifZsRbV1uPHWNyd7ePXtN5","created_at":"2024-12-27T06:34:21.21Z","updated_at":"2024-12-27T06:35:01.56Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":null,"merchant_identity":null,"messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":"PIiYHJ6dDykz1fihySDWzxd4","payment_instrument_verification_details":{"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_domestic":null,"push_to_card_cross_border":null,"card_type":null,"billing_currency":null,"issuer_country":"UNKNOWN","name_verification_results":{"first_name":"UNKNOWN","last_name":"UNKNOWN","middle_name":"UNKNOWN","name":"UNKNOWN"}},"processor":"DUMMY_V1","raw":"RawDummyInstrumentVerificationResult","state":"SUCCEEDED","tags":{},"trace_id":"2764b9b0-dbec-4b21-a3b6-c2693015761e","type":"PAYMENT_INSTRUMENT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VIifZsRbV1uPHWNyd7ePXtN5"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"payment_instrument":{"href":"https://finix.sandbox-payments-api.com/payment_instruments/PIiYHJ6dDykz1fihySDWzxd4"}}},"key":"Verification - Payment Instrument","summary":"Verification - Payment Instrument","id":"paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Payment Instrument"},"paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Merchant":{"value":{"id":"VI5pMpAg6e5bRaMREhrYjwQW","created_at":"2024-12-04T07:56:00.03Z","updated_at":"2024-12-04T07:57:01.95Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","identity":null,"merchant":"MUmfEGv5bMpSJ9k5TFRUjkmm","merchant_identity":"ID6UfSm1d4WPiWgLYmbyeo3H","messages":[],"outcome_summary":null,"outcomes":null,"payment_instrument":null,"payment_instrument_verification_details":{"billing_currency":null,"card_type":null,"issuer_country":null,"pull_from_card_cross_border":null,"pull_from_card_domestic":null,"push_to_card_cross_border":null,"push_to_card_domestic":null},"processor":"DUMMY_V1","raw":"RawDummyMerchantUnderwriteResult","reverification_reason":{"review_type":null,"initiated_by":null,"reason_description":null},"state":"SUCCEEDED","sub_type":null,"tags":{},"trace_id":"26577eee-2db9-4707-85f6-5b8f9c1e5376","type":"MERCHANT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VI5pMpAg6e5bRaMREhrYjwQW"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"},"merchant":{"href":"https://finix.sandbox-payments-api.com/merchants/MUmfEGv5bMpSJ9k5TFRUjkmm"}}},"key":"Verification - Merchant","summary":"Verification - Merchant","id":"paths/~1verifications~1{verification_id}/get/responses/200/content/application~1json/examples/Verification - Merchant"},"paths/~1verifications~1{verification_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VI5pMpAg6e5bRaMREhrYjwQW"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1verifications~1{verification_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1verifications~1{verification_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VI5pMpAg6e5bRaMREhrYjwQW"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1verifications~1{verification_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1verifications~1{verification_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"VI5pMpAg6e5bRaMREhrYjwQW was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VI5pMpAg6e5bRaMREhrYjwQW"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1verifications~1{verification_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1verifications~1{verification_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/verifications/VI5pMpAg6e5bRaMREhrYjwQW"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1verifications~1{verification_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Minimal Fields - No Authentication":{"value":{"url":"https://httpbin.org/post"},"key":"Webhook - Minimal Fields - No Authentication","summary":"Webhook - Minimal Fields - No Authentication","id":"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Minimal Fields - No Authentication"},"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - All Fields":{"value":{"authentication":{"basic":{"password":"basic-auth-password","username":"basic-auth-username"},"type":"BASIC"},"enabled_events":[{"entity":"authorization","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"evidence","types":["created"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]},{"entity":"verification","types":["created","updated"]}],"nickname":"production-payment-events","url":"https://httpbin.org/post"},"key":"Webhook - All Fields","summary":"Webhook - All Fields","id":"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - All Fields"},"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Basic Authentication":{"value":{"authentication":{"basic":{"password":"basic-auth-password","username":"basic-auth-username"},"type":"BASIC"},"url":"https://httpbin.org/post"},"key":"Webhook - Basic Authentication","summary":"Webhook - Basic Authentication","id":"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Basic Authentication"},"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Bearer Token":{"value":{"authentication":{"bearer":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"},"type":"BEARER"},"url":"https://httpbin.org/post"},"key":"Webhook - Bearer Token","summary":"Webhook - Bearer Token","id":"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Bearer Token"},"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Event Filtering":{"value":{"authentication":{"type":"NONE"},"enabled_events":[{"entity":"authorization","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"evidence","types":["created"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]},{"entity":"verification","types":["created","updated"]}],"url":"https://httpbin.org/post"},"key":"Webhook - Event Filtering","summary":"Webhook - Event Filtering","id":"paths/~1webhooks/post/requestBody/content/application~1json/examples/Webhook - Event Filtering"},"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Minimal Fields - No Authentication":{"value":{"id":"WHu6Mf9zu5cBBjtGBZdfR1p3","created_at":"2026-05-18T17:13:28.92Z","updated_at":"2026-05-18T17:13:28.92Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"NONE"},"enabled":true,"enabled_events":[{"entity":"transfer","types":["created","updated"]},{"entity":"settlement","types":["created"]},{"entity":"dispute","types":["created","updated"]},{"entity":"instrument_history","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]}],"is_accepting_events":true,"nickname":null,"previous_secret_expires_at":null,"secret_signing_key":"167463ce9c97b98baca1eb9a70bd99478d21a7b50456715875a2aa569e6f35d5","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHu6Mf9zu5cBBjtGBZdfR1p3"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Webhook - Minimal Fields - No Authentication","summary":"Webhook - Minimal Fields - No Authentication","id":"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Minimal Fields - No Authentication"},"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - All Fields":{"value":{"id":"WHr48thrAc8HqnxSCA1wNXkT","created_at":"2026-05-18T17:12:47.54Z","updated_at":"2026-05-18T17:12:47.54Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"BASIC"},"enabled":true,"enabled_events":[{"entity":"authorization","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"evidence","types":["created"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]},{"entity":"verification","types":["created","updated"]}],"is_accepting_events":true,"nickname":"production-payment-events","previous_secret_expires_at":null,"secret_signing_key":"40948e42687507d64e18ba92c528773b0cb1d5e723909b3f7fc7fff52976a23e","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHr48thrAc8HqnxSCA1wNXkT"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Webhook - All Fields","summary":"Webhook - All Fields","id":"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - All Fields"},"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Basic Authentication":{"value":{"id":"WH63VSRsJfo1BxDTpbTSDLiP","created_at":"2026-05-18T15:06:34.32Z","updated_at":"2026-05-18T15:06:34.32Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"BASIC"},"enabled":true,"enabled_events":[{"entity":"transfer","types":["created","updated"]},{"entity":"settlement","types":["created"]},{"entity":"dispute","types":["created","updated"]},{"entity":"instrument_history","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]}],"is_accepting_events":true,"nickname":null,"previous_secret_expires_at":null,"secret_signing_key":"f955f23a619b6d3d61dd5396288df65824e1cc4b938d1bc14809bec69a2edc09","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WH63VSRsJfo1BxDTpbTSDLiP"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Webhook - Basic Authentication","summary":"Webhook - Basic Authentication","id":"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Basic Authentication"},"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Bearer Token":{"value":{"id":"WHg2yEcBdTj3Ly3TqLv44vK2","created_at":"2026-05-18T15:08:49.86Z","updated_at":"2026-05-18T15:08:49.86Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"BEARER"},"enabled":true,"enabled_events":[{"entity":"transfer","types":["created","updated"]},{"entity":"settlement","types":["created"]},{"entity":"dispute","types":["created","updated"]},{"entity":"instrument_history","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]}],"is_accepting_events":true,"nickname":null,"previous_secret_expires_at":null,"secret_signing_key":"7c323894a8707755eba9fa33a9f7c2de3e0a6d336f0c779213fc75d6dfe219e0","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHg2yEcBdTj3Ly3TqLv44vK2"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Webhook - Bearer Token","summary":"Webhook - Bearer Token","id":"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Bearer Token"},"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Event Filtering":{"value":{"id":"WHpyFYPQPFKvDwwUMK5FdRXY","created_at":"2026-05-18T14:56:26.85Z","updated_at":"2026-05-18T14:56:26.85Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"NONE"},"enabled":true,"enabled_events":[{"entity":"authorization","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"evidence","types":["created"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]},{"entity":"verification","types":["created","updated"]}],"is_accepting_events":true,"nickname":null,"previous_secret_expires_at":null,"secret_signing_key":"5ba906584fc6f966cb68ea407980f4997ccac5a1d9cb12f35ede820784f00124","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHpyFYPQPFKvDwwUMK5FdRXY"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Webhook - Event Filtering","summary":"Webhook - Event Filtering","id":"paths/~1webhooks/post/responses/201/content/application~1json/examples/Webhook - Event Filtering"},"paths/~1webhooks/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1webhooks/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1webhooks/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1webhooks/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1webhooks/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1webhooks/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1webhooks/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1webhooks/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1webhooks/post/responses/422/content/application~1json/examples/Failed to create webhook":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"83ee5d186760f42d","message":"Failed to create webhook. Unable to call the configured URL with an empty payload. Received Response Code: {503}","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Failed to create webhook","summary":"Failed to create webhook","id":"paths/~1webhooks/post/responses/422/content/application~1json/examples/Failed to create webhook"},"paths/~1webhooks/get/responses/200/content/application~1json/examples/List of Webhooks":{"value":{"_embedded":{"webhooks":[{"id":"WH7kP4LjqxcCgUj7zH51yJe7","created_at":"2026-09-19T19:56:27.65Z","updated_at":"2026-09-19T19:56:27.65Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"NONE"},"enabled":true,"enabled_events":[{"entity":"transfer","types":["created"]}],"is_accepting_events":true,"nickname":null,"previous_secret_expires_at":null,"url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WH7kP4LjqxcCgUj7zH51yJe7"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"WHjrtpUjrYRBLXpYNJsE9wHA","created_at":"2026-09-08T03:51:33.69Z","updated_at":"2026-09-08T03:51:33.69Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"NONE"},"enabled":true,"enabled_events":[{"entity":"settlement","types":["created"]},{"entity":"instrument_history","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"transfer","types":["created","updated"]},{"entity":"dispute","types":["created","updated"]}],"is_accepting_events":true,"nickname":null,"previous_secret_expires_at":null,"url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHjrtpUjrYRBLXpYNJsE9wHA"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"WHjmqdGRnNwWe8M7DbwfsiFq","created_at":"2026-09-08T03:51:32.51Z","updated_at":"2026-09-08T03:51:32.51Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"NONE"},"enabled":true,"enabled_events":[{"entity":"evidence","types":["created"]},{"entity":"authorization","types":["created","updated"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"verification","types":["created","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]}],"is_accepting_events":true,"nickname":null,"previous_secret_expires_at":null,"url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHjmqdGRnNwWe8M7DbwfsiFq"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/notification/webhooks?offset=0&limit=3&sort=created_at,desc&sort=id,desc"},"next":{"href":"https://finix.sandbox-payments-api.com/notification/webhooks?offset=3&limit=3&sort=created_at,desc&sort=id,desc"},"last":{"href":"https://finix.sandbox-payments-api.com/notification/webhooks?offset=1653&limit=3&sort=created_at,desc&sort=id,desc"}},"page":{"offset":0,"limit":3,"count":1654}},"key":"List of Webhooks","summary":"List of Webhooks","id":"paths/~1webhooks/get/responses/200/content/application~1json/examples/List of Webhooks"},"paths/~1webhooks/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1webhooks/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1webhooks/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1webhooks/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1webhooks/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1webhooks/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1webhooks/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1webhooks/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Webhook":{"value":{"id":"WH63VSRsJfo1BxDTpbTSDLiP","created_at":"2026-05-18T15:06:34.32Z","updated_at":"2026-05-18T15:06:34.32Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"BASIC"},"enabled":true,"enabled_events":[{"entity":"transfer","types":["created","updated"]},{"entity":"settlement","types":["created"]},{"entity":"dispute","types":["created","updated"]},{"entity":"instrument_history","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]}],"is_accepting_events":true,"nickname":null,"previous_secret_expires_at":null,"secret_signing_key":"f955f23a619b6d3d61dd5396288df65824e1cc4b938d1bc14809bec69a2edc09","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WH63VSRsJfo1BxDTpbTSDLiP"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Webhook","summary":"Webhook","id":"paths/~1webhooks~1{webhook_id}/get/responses/200/content/application~1json/examples/Webhook"},"paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1webhooks~1{webhook_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1webhooks~1{webhook_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"WHhEyB1GdW8NsP2T7Rv6nfc6 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1webhooks~1{webhook_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1webhooks~1{webhook_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - All Fields":{"value":{"authentication":{"basic":{"password":"basic-auth-password","username":"basic-auth-username"},"type":"BASIC"},"enabled":true,"enabled_events":[{"entity":"authorization","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"evidence","types":["created"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]},{"entity":"verification","types":["created","updated"]}],"generate_new_secret":true,"nickname":"production-payment-events","previous_secret_active_hours":24,"url":"https://httpbin.org/post"},"key":"Update Webhook - All Fields","summary":"Update Webhook - All Fields","id":"paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - All Fields"},"paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook":{"value":{"authentication":{"basic":{"password":"basic-auth-password","username":"basic-auth-username"},"type":"BASIC"}},"key":"Update Webhook - Add Authentication to a Webhook","summary":"Update Webhook - Add Authentication to a Webhook","id":"paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook"},"paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events":{"value":{"enabled":false},"key":"Update Webhook - Enable/Disable Webhook Events","summary":"Update Webhook - Enable/Disable Webhook Events","id":"paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events"},"paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Filter Events":{"value":{"enabled_events":[{"entity":"authorization","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"evidence","types":["created"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]},{"entity":"verification","types":["created","updated"]}]},"key":"Update Webhook - Filter Events","summary":"Update Webhook - Filter Events","id":"paths/~1webhooks~1{webhook_id}/put/requestBody/content/application~1json/examples/Update Webhook - Filter Events"},"paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - All Fields":{"value":{"id":"WHhEyB1GdW8NsP2T7Rv6nfc6","created_at":"2024-12-30T14:01:12.22Z","updated_at":"2026-05-22T14:50:57.56Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"BASIC"},"enabled":true,"enabled_events":[{"entity":"authorization","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"evidence","types":["created"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]},{"entity":"verification","types":["created","updated"]}],"is_accepting_events":true,"nickname":"production-payment-events","previous_secret_expires_at":null,"url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Update Webhook - All Fields","summary":"Update Webhook - All Fields","id":"paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - All Fields"},"paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook":{"value":{"id":"WHhRJLcEt53voydzyLQ9aYs7","created_at":"2026-05-26T20:21:52.83Z","updated_at":"2026-09-25T20:06:36.32Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"BASIC"},"enabled":true,"enabled_events":[{"entity":"evidence","types":["created"]},{"entity":"authorization","types":["created","updated"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"verification","types":["created","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]}],"is_accepting_events":true,"nickname":"custom-events","previous_secret_expires_at":"2026-08-13T14:58:29.58463Z","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhRJLcEt53voydzyLQ9aYs7"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Update Webhook - Add Authentication to a Webhook","summary":"Update Webhook - Add Authentication to a Webhook","id":"paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Add Authentication to a Webhook"},"paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events":{"value":{"id":"WHhRJLcEt53voydzyLQ9aYs7","created_at":"2026-05-26T20:21:52.83Z","updated_at":"2026-09-25T20:06:36.64Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"BASIC"},"enabled":false,"enabled_events":[{"entity":"evidence","types":["created"]},{"entity":"authorization","types":["created","updated"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"verification","types":["created","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]}],"is_accepting_events":false,"nickname":"custom-events","previous_secret_expires_at":"2026-08-13T14:58:29.58463Z","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhRJLcEt53voydzyLQ9aYs7"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Update Webhook - Enable/Disable Webhook Events","summary":"Update Webhook - Enable/Disable Webhook Events","id":"paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Enable~1Disable Webhook Events"},"paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Filter Events":{"value":{"id":"WHhRJLcEt53voydzyLQ9aYs7","created_at":"2026-05-26T20:21:52.83Z","updated_at":"2026-09-25T20:06:36.94Z","application":"APc9vhYcPsRuTSpKD9KpMtPe","authentication":{"type":"BASIC"},"enabled":true,"enabled_events":[{"entity":"authorization","types":["created","updated"]},{"entity":"balance_transfer","types":["created","updated"]},{"entity":"evidence","types":["created"]},{"entity":"gateway_integration","types":["created"]},{"entity":"merchant","types":["created","underwritten","updated"]},{"entity":"onboarding_form","types":["created","updated"]},{"entity":"transfer_attempt","types":["created"]},{"entity":"verification","types":["created","updated"]}],"is_accepting_events":true,"nickname":"custom-events","previous_secret_expires_at":"2026-08-13T14:58:29.58463Z","url":"https://httpbin.org/post","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhRJLcEt53voydzyLQ9aYs7"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Update Webhook - Filter Events","summary":"Update Webhook - Filter Events","id":"paths/~1webhooks~1{webhook_id}/put/responses/200/content/application~1json/examples/Update Webhook - Filter Events"},"paths/~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1webhooks~1{webhook_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1webhooks~1{webhook_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1webhooks~1{webhook_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1webhooks~1{webhook_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"WHhEyB1GdW8NsP2T7Rv6nfc6 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1webhooks~1{webhook_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1webhooks~1{webhook_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/webhooks/WHhEyB1GdW8NsP2T7Rv6nfc6"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1webhooks~1{webhook_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1gateway_integrations/post/requestBody/content/application~1json/examples/Gateway Integration":{"value":{"email":"user@example.com","linked_to":"MUeg77opgdgQpwejzC9wCNmK","tags":{"order_id":"ORD-123"},"type":"CYBERSOURCE"},"key":"Gateway Integration","summary":"Gateway Integration","id":"paths/~1gateway_integrations/post/requestBody/content/application~1json/examples/Gateway Integration"},"paths/~1gateway_integrations/post/responses/201/content/application~1json/examples/Gateway Integration":{"value":{"id":"gateway_integration_j1KV2mwRgA8pSGGrWWVijc","created_at":"2026-05-22T01:41:01.30Z","updated_at":"2026-05-22T01:41:01.30Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","email":"user@example.com","linked_to":"MUeg77opgdgQpwejzC9wCNmK","linked_type":"MERCHANT","state":"PENDING","tags":{"gateway_name":"shopify"},"type":"CYBERSOURCE","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations/gateway_integration_j1KV2mwRgA8pSGGrWWVijc"}}},"key":"Gateway Integration","summary":"Gateway Integration","id":"paths/~1gateway_integrations/post/responses/201/content/application~1json/examples/Gateway Integration"},"paths/~1gateway_integrations/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1gateway_integrations/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1gateway_integrations/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1gateway_integrations/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1gateway_integrations/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1gateway_integrations/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1gateway_integrations/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1gateway_integrations/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1gateway_integrations/get/responses/200/content/application~1json/examples/List of Gateway Integrations":{"value":{"_embedded":{"gateway_integrations":[{"id":"gateway_integration_j1KV2mwRgA8pSGGrWWVijc","created_at":"2026-05-22T01:41:01.30Z","updated_at":"2026-05-22T01:41:01.30Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","email":"johndoe@acme.com","linked_to":"MUeg77opgdgQpwejzC9wCNmK","linked_type":"MERCHANT","state":"SUCCEEDED","tags":{"gateway_name":"shopify"},"type":"CYBERSOURCE","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations/gateway_integration_j1KV2mwRgA8pSGGrWWVijc"}}}]}},"key":"List of Gateway Integrations","summary":"List of Gateway Integrations","id":"paths/~1gateway_integrations/get/responses/200/content/application~1json/examples/List of Gateway Integrations"},"paths/~1gateway_integrations/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1gateway_integrations/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1gateway_integrations/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1gateway_integrations/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1gateway_integrations/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1gateway_integrations/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1gateway_integrations/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1gateway_integrations/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/200/content/application~1json/examples/Gateway Integration":{"value":{"id":"gateway_integration_j1KV2mwRgA8pSGGrWWVijc","created_at":"2026-05-22T01:41:01.30Z","updated_at":"2026-05-22T01:41:01.30Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","email":"user@example.com","linked_to":"MUeg77opgdgQpwejzC9wCNmK","linked_type":"MERCHANT","state":"PENDING","tags":{"gateway_name":"shopify"},"type":"CYBERSOURCE","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations/gateway_integration_j1KV2mwRgA8pSGGrWWVijc"}}},"key":"Gateway Integration","summary":"Gateway Integration","id":"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/200/content/application~1json/examples/Gateway Integration"},"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations/gateway_integration_TBamsYxqr1KSnT4U2x9SP"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations/gateway_integration_TBamsYxqr1KSnT4U2x9SP"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"gateway_integration_TBamsYxqr1KSnT4U2x9SP was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations/gateway_integration_TBamsYxqr1KSnT4U2x9SP"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/gateway_integrations/gateway_integration_TBamsYxqr1KSnT4U2x9SP"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1gateway_integrations~1{gateway_integration_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - Minimal Fields":{"value":{"entity_id":"TRnErBfrHLgdAi3BqAkWLN27","send_receipt_to_buyer":true},"key":"Receipt - Minimal Fields","summary":"Receipt - Minimal Fields","id":"paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - Minimal Fields"},"paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - All Fields":{"value":{"amount_breakdown":{"additional_buyer_charges":{"convenience_amount":150},"discount_amount":100,"estimated_tax_amount":200,"shipping_amount":100,"subtotal_amount":600,"tip_amount":50},"customization_details":{"footer_sections":[{"name":"Return Policy","value":"All sales final."}],"subheader_attributes":[{"name":"Contract ID","value":"CTR-9988"},{"name":"PO Number","value":"PO-12345"}],"summary_sections":[{"name":"Terms","value":"Payment due within 30 days."},{"name":"Memo","value":"Thank you for your business."}]},"entity_id":"TRdJKpiu8WgRYEzCfqxVr66P","items":[{"description":"Printing paper (1 box).","name":"Printing Paper","price_details":{"amount_excluding_sales_tax":200,"currency":"USD","item_discount_amount":100,"price_type":"PROMOTIONAL","regular_amount":350,"sale_amount":250},"quantity":1},{"description":"Printing ink (1 carton).","name":"Printing Ink","price_details":{"amount_excluding_sales_tax":300,"currency":"USD","item_discount_amount":0,"price_type":"REGULAR","regular_amount":350,"sale_amount":350},"quantity":1}],"requested_delivery_methods":[{"destinations":["johndoe@gmail.com"],"type":"EMAIL"},{"destinations":["3346497818"],"type":"SMS"},{"destinations":["DV12343234"],"type":"PRINT"}],"send_receipt_to_buyer":true},"key":"Receipt - All Fields","summary":"Receipt - All Fields","id":"paths/~1receipts/post/requestBody/content/application~1json/examples/Receipt - All Fields"},"paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - Minimal Fields":{"value":{"id":"receipt_cEpKXq7zMp9XfZE5iSvdd","created_at":"2026-09-25T20:05:30.51Z","updated_at":"2026-09-25T20:05:30.51Z","additional_details":null,"amount":100,"amount_breakdown":null,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","customization_details":null,"device_id":null,"entity_details":{"id":"TRnErBfrHLgdAi3BqAkWLN27","created_at":"2024-12-04T08:51:43.86Z","operation_key":"CARD_NOT_PRESENT_CAPTURE","type":"TRANSFER"},"items":[],"merchant_details":{"id":"MU7noQ1wdgdAeAfymw2rfBMq","business_address":{"city":"San Francisco","country":"USA","line1":"0 2nd Street","line2":null,"postal_code":"94107","region":"CA"},"business_name":"Finix Documentation 2025","doing_business_as":"Finix Documentation 2025"},"network_details":null,"payment_instrument_details":{"id":"PIkxmtueemLD6dN9ZoWGHT44","billing_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 8","postal_code":"94114","region":"CA"},"bin":"489514","brand":"VISA","card_type":"UNKNOWN","last_four":"0006","name":"John Smith","type":"PAYMENT_CARD"},"receipt_url":"https://receipt-link.sandbox-payment-form.com/tCQytQ","requested_delivery_methods":[],"send_receipt_to_buyer":true,"type":"BUYER","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_cEpKXq7zMp9XfZE5iSvdd"}}},"key":"Receipt - Minimal Fields","summary":"Receipt - Minimal Fields","id":"paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - Minimal Fields"},"paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - All Fields":{"value":{"id":"receipt_cEpKXnvNACvGVrJFNRbCK","created_at":"2026-09-25T20:05:29.95Z","updated_at":"2026-09-25T20:05:29.95Z","additional_details":null,"amount":1000,"amount_breakdown":{"additional_buyer_charges":{"convenience_amount":150,"rent_surcharge_amount":null,"surcharge_amount":null},"customs_duty_amount":null,"discount_amount":100,"estimated_tax_amount":200,"shipping_amount":100,"subtotal_amount":600,"tip_amount":50},"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","customization_details":{"subheader_attributes":[{"name":"Contract ID","value":"CTR-9988"},{"name":"PO Number","value":"PO-12345"}],"summary_sections":[{"name":"Terms","value":"Payment due within 30 days."},{"name":"Memo","value":"Thank you for your business."}],"footer_sections":[{"name":"Return Policy","value":"All sales final."}]},"device_id":null,"entity_details":{"id":"TRdJKpiu8WgRYEzCfqxVr66P","created_at":"2026-03-20T14:59:32.57Z","operation_key":"CARD_NOT_PRESENT_SALE","type":"TRANSFER"},"items":[{"description":"Printing paper (1 box).","image_details":null,"item_details":null,"name":"Printing Paper","price_details":{"sale_amount":250,"currency":"USD","price_type":"PROMOTIONAL","regular_amount":350,"amount_excluding_sales_tax":200,"item_discount_amount":100},"quantity":1},{"description":"Printing ink (1 carton).","image_details":null,"item_details":null,"name":"Printing Ink","price_details":{"sale_amount":350,"currency":"USD","price_type":"REGULAR","regular_amount":350,"amount_excluding_sales_tax":300,"item_discount_amount":0},"quantity":1}],"merchant_details":{"id":"MUe17jKSrfPetoeiJQzzjmA2","business_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 8","postal_code":"94114","region":"CA"},"business_name":"Finix Flowers","doing_business_as":"Finix Flowers"},"network_details":null,"payment_instrument_details":{"id":"PI6iQcTtJNCS8GZAVKYi5Ueb","billing_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 8","postal_code":"94114","region":"CA"},"bin":"489514","brand":"VISA","card_type":"UNKNOWN","last_four":"0006","name":"John Smith","type":"PAYMENT_CARD"},"receipt_url":"https://receipt-link.sandbox-payment-form.com/UgX9XP","requested_delivery_methods":[{"type":"EMAIL","destinations":["johndoe@gmail.com"]},{"type":"SMS","destinations":["3346497818"]},{"type":"PRINT","destinations":["DV12343234"]}],"send_receipt_to_buyer":true,"type":"BUYER","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_cEpKXnvNACvGVrJFNRbCK"}}},"key":"Receipt - All Fields","summary":"Receipt - All Fields","id":"paths/~1receipts/post/responses/201/content/application~1json/examples/Receipt - All Fields"},"paths/~1receipts/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1receipts/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1receipts/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1receipts/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1receipts/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1receipts/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1receipts/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1receipts/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1receipts/post/responses/422/content/application~1json/examples/Unsupported transfer type":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"dbe4f2c83739c3d4ac26a9d987c8f2e0","message":"A receipt can only be created for Transfers of type DEBIT or REVERSAL, or for an UNREFERENCED_REFUND.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts"}}}]}},"key":"Unsupported transfer type","summary":"Transfer not type DEBIT, REVERSAL, or UNREFERENCED_REFUND","id":"paths/~1receipts/post/responses/422/content/application~1json/examples/Unsupported transfer type"},"paths/~1receipts~1{receipt_id}/get/responses/200/content/application~1json/examples/Receipt":{"value":{"id":"receipt_cE9rPGb6fxVmy7uzWQZDx","created_at":"2026-09-17T17:58:48.41Z","updated_at":"2026-09-17T17:58:48.41Z","additional_details":null,"amount":1000,"amount_breakdown":{"additional_buyer_charges":{"convenience_amount":150,"rent_surcharge_amount":null,"surcharge_amount":null},"customs_duty_amount":null,"discount_amount":100,"estimated_tax_amount":200,"shipping_amount":100,"subtotal_amount":600,"tip_amount":50},"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","currency":"USD","customization_details":{"subheader_attributes":[{"name":"Contract ID","value":"CTR-9988"},{"name":"PO Number","value":"PO-12345"}],"summary_sections":[{"name":"Terms","value":"Payment due within 30 days."},{"name":"Memo","value":"Thank you for your business."}],"footer_sections":[{"name":"Return Policy","value":"All sales final."}]},"device_id":null,"entity_details":{"id":"TRdJKpiu8WgRYEzCfqxVr66P","created_at":"2026-03-20T14:59:32.57Z","operation_key":"CARD_NOT_PRESENT_SALE","type":"TRANSFER"},"items":[{"description":"Printing paper (1 box).","image_details":null,"item_details":null,"name":"Printing Paper","price_details":{"sale_amount":250,"currency":"USD","price_type":"PROMOTIONAL","regular_amount":350,"amount_excluding_sales_tax":200,"item_discount_amount":100},"quantity":1},{"description":"Printing ink (1 carton).","image_details":null,"item_details":null,"name":"Printing Ink","price_details":{"sale_amount":350,"currency":"USD","price_type":"REGULAR","regular_amount":350,"amount_excluding_sales_tax":300,"item_discount_amount":0},"quantity":1}],"merchant_details":{"id":"MUe17jKSrfPetoeiJQzzjmA2","business_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 8","postal_code":"94114","region":"CA"},"business_name":"Finix Flowers","doing_business_as":"Finix Flowers"},"network_details":null,"payment_instrument_details":{"id":"PI6iQcTtJNCS8GZAVKYi5Ueb","billing_address":{"city":"San Mateo","country":"USA","line1":"741 Douglass St","line2":"Apartment 8","postal_code":"94114","region":"CA"},"bin":"489514","brand":"VISA","card_type":"UNKNOWN","last_four":"0006","name":"John Smith","type":"PAYMENT_CARD"},"receipt_url":"https://receipt.sandbox-payments-checkout.com/k0ZpXi","requested_delivery_methods":[{"type":"EMAIL","destinations":["johndoe@gmail.com"]},{"type":"SMS","destinations":["3346497818"]},{"type":"PRINT","destinations":["DV12343234"]}],"send_receipt_to_buyer":true,"type":"BUYER","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_cE9rPGb6fxVmy7uzWQZDx"}}},"key":"Receipt","summary":"Receipt","id":"paths/~1receipts~1{receipt_id}/get/responses/200/content/application~1json/examples/Receipt"},"paths/~1receipts~1{receipt_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1receipts~1{receipt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1receipts~1{receipt_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1receipts~1{receipt_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1receipts~1{receipt_id}/get/responses/404/content/application~1json/examples/NotFound":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"receipt_ciLiFPTNSPBAJ3FtFFpXG was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG"}}}]}},"key":"NotFound","summary":"NotFound","id":"paths/~1receipts~1{receipt_id}/get/responses/404/content/application~1json/examples/NotFound"},"paths/~1receipts~1{receipt_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1receipts~1{receipt_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/requestBody/content/application~1json/examples/Delivery Attempt":{"value":{"requested_delivery_methods":[{"destinations":["larrywilliams@gmail.com"],"type":"EMAIL"},{"destinations":["8005550100"],"type":"SMS"},{"destinations":["DVsEanpBtsAVvCHbNXkFaH6f"],"type":"PRINT"}]},"key":"Delivery Attempt","summary":"Delivery Attempt","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/requestBody/content/application~1json/examples/Delivery Attempt"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/200/content/application~1json/examples/List of Receipt Delivery Attempts":{"value":{"_embedded":{"delivery_attempts":[{"id":"delivery_attempt_czZUcR2CPT4eXijPNpxkh","created_at":"2026-05-13T16:41:34.59Z","destination":"DVsEanpBtsAVvCHbNXkFaH6f","receipt_id":"receipt_ciLiFPTNSPBAJ3FtFFpXG","state":"FAILED","type":"PRINT","updated_at":"2026-05-13T16:41:34.59Z"},{"id":"delivery_attempt_czZUcQNtVVJz7ai2aax39","created_at":"2026-05-13T16:41:34.54Z","destination":"8005550175","receipt_id":"receipt_ciLiFPTNSPBAJ3FtFFpXG","state":"SUCCEEDED","type":"SMS","updated_at":"2026-05-13T16:41:34.54Z"},{"id":"delivery_attempt_czZUcPNXcWQG8inu4wYi9","created_at":"2026-05-13T16:41:34.30Z","destination":"benroundtree@gmail.com","receipt_id":"receipt_ciLiFPTNSPBAJ3FtFFpXG","state":"SUCCEEDED","type":"EMAIL","updated_at":"2026-05-13T16:41:34.30Z"}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts?limit=3&after_cursor=delivery_attempt_czZUcPNXcWQG8inu4wYi9"}},"page":{"limit":3,"next_cursor":"delivery_attempt_czZUcPNXcWQG8inu4wYi9"}},"key":"List of Receipt Delivery Attempts","summary":"List of Receipt Delivery Attempts","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/200/content/application~1json/examples/List of Receipt Delivery Attempts"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/receipts/receipt_ciLiFPTNSPBAJ3FtFFpXG/delivery_attempts"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1receipts~1{receipt_id}~1delivery_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Minimal Fields":{"value":{"amount":10000,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"currency":"USD","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","subscription_details":{"collection_method":"BILL_AUTOMATICALLY"}},"key":"Subscription - Minimal Fields","summary":"Subscription - Minimal Fields","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Minimal Fields"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - All Fields":{"value":{"amount":19900,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[{"destinations":["johnsmithbuyer@gmail.com"],"type":"EMAIL"},{"destinations":["7147148784"],"type":"SMS"}],"shipping_address":{"city":"Middletown","country":"USA","line1":"324 Oak Avenue","line2":"Apartment 7","postal_code":"19734","region":"DE"}},"currency":"USD","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","nickname":"Finflix Gold Package","start_subscription_at":"2027-06-01T00:00:00.000Z","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","discount_phase_details":{"amount":1000,"billing_interval_count":3},"notification_preferences":{"send_confirmation":true},"trial_details":{"interval_count":2,"interval_type":"MONTH"}},"tags":{"order_id":"ORD-123"},"total_billing_intervals":12},"key":"Subscription - All Fields","summary":"Subscription - All Fields","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - All Fields"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Billing Cycle Day":{"value":{"amount":19900,"billing_cycle_day":1,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDs8jiuvHQwdKpdC7bj16MbG","instrument_id":"PIvEirFa32BxZWgsFyt8M7Q6"},"currency":"USD","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","subscription_details":{"collection_method":"BILL_AUTOMATICALLY"}},"key":"Subscription - Billing Cycle Day","summary":"Subscription - Billing Cycle Day","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Billing Cycle Day"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Discount Phase":{"value":{"amount":2000,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"currency":"USD","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","discount_phase_details":{"amount":1000,"billing_interval_count":3}}},"key":"Subscription - Discount Phase","summary":"Subscription - Discount Phase","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Discount Phase"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length":{"value":{"amount":19900,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"currency":"USD","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","subscription_details":{"collection_method":"BILL_AUTOMATICALLY"},"total_billing_intervals":12},"key":"Subscription - Fixed-Length","summary":"Subscription - Fixed-Length","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length - End Date":{"value":{"amount":19900,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"currency":"USD","end_subscription_at":"2026-12-31T18:39:34.38Z","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","subscription_details":{"collection_method":"BILL_AUTOMATICALLY"}},"key":"Subscription - Fixed-Length - End Date","summary":"Subscription - Fixed-Length - End Date","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Fixed-Length - End Date"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Future Start Date":{"value":{"amount":10000,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"currency":"USD","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","start_subscription_at":"2027-06-01T00:00:00.000Z","subscription_details":{"collection_method":"BILL_AUTOMATICALLY"}},"key":"Subscription - Future Start Date","summary":"Subscription - Future Start Date","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Future Start Date"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Trial Period":{"value":{"amount":10000,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"currency":"USD","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","trial_details":{"interval_count":1,"interval_type":"MONTH"}}},"key":"Subscription - Trial Period","summary":"Subscription - Trial Period","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Trial Period"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields":{"value":{"buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"},"key":"Subscription - Subscription Plan - Minimal Fields","summary":"Subscription - Subscription Plan - Minimal Fields","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - All Fields":{"value":{"buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[{"destinations":["johnsmithbuyer@gmail.com"],"type":"EMAIL"},{"destinations":["7147148784"],"type":"SMS"}],"shipping_address":{"city":"Middletown","country":"USA","line1":"324 Oak Avenue","line2":"Apartment 7","postal_code":"19734","region":"DE"}},"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","nickname":"Finflix Gold Package","start_subscription_at":"2027-06-01T00:00:00.000Z","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE","tags":{"order_id":"ORD-123"},"total_billing_intervals":12},"key":"Subscription - Subscription Plan - All Fields","summary":"Subscription - Subscription Plan - All Fields","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - All Fields"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length":{"value":{"buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE","total_billing_intervals":12},"key":"Subscription - Subscription Plan - Fixed-Length","summary":"Subscription - Subscription Plan - Fixed-Length","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date":{"value":{"buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"end_subscription_at":"2026-12-31T18:45:07.26Z","linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"},"key":"Subscription - Subscription Plan - Fixed-Length - End Date","summary":"Subscription - Subscription Plan - Fixed-Length - End Date","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date"},"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date":{"value":{"buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve"},"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","start_subscription_at":"2027-06-01T00:00:00.000Z","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"},"key":"Subscription - Subscription Plan - Future Start Date","summary":"Subscription - Subscription Plan - Future Start Date","id":"paths/~1subscriptions/post/requestBody/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Minimal Fields":{"value":{"id":"subscription_cEpKYsVx13tE7utwrEwSz","created_at":"2026-09-25T20:05:44.63Z","updated_at":"2026-09-25T20:05:44.63Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":25,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-09-25T20:05:43.00Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":9,"day":25},"nickname":null,"start_subscription_at":"2026-09-25T20:04:43.651Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"EVERGREEN","subscription_plan_id":null,"tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEpKYsVx13tE7utwrEwSz"}}},"key":"Subscription - Minimal Fields","summary":"Subscription - Minimal Fields","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Minimal Fields"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - All Fields":{"value":{"id":"subscription_czjuNwSvWAQiCfgguhKKd","created_at":"2026-04-22T21:11:31.12Z","updated_at":"2026-04-22T21:11:31.12Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[{"type":"EMAIL","destinations":["abc@test.com"]},{"type":"SMS","destinations":["2348765431"]}],"shipping_address":{"city":"Middletown","country":"USA","line1":"324 Oak Avenue","line2":"Apartment 7","postal_code":"19734","region":"DE"}},"canceled_via":null,"currency":"USD","expires_at":"2028-08-01T00:00:00.000Z","first_charge_at":"2027-08-01T00:00:00.000Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2027,"month":8,"day":1},"nickname":"Finflix Gold Package","start_subscription_at":"2027-06-01T00:00:00.000Z","state":"NOT_STARTED","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":{"interval_type":"MONTH","interval_count":2,"trial_started_at":null,"trial_expected_start_at":"2027-06-01T00:00:00.000Z","trial_expected_end_at":"2027-08-01T00:00:00.000Z"},"discount_phase_details":{"amount":1000,"billing_interval_count":3,"discount_phase_started_at":null,"discount_phase_expected_start_at":"2027-08-01T00:00:00.000Z","discount_phase_expected_end_at":"2027-11-01T00:00:00.000Z"},"notification_preferences":{"send_confirmation":true}},"subscription_link_id":null,"subscription_phase":"NONE","subscription_plan_id":null,"tags":{"order_number":"21DFASJSAKAS"},"total_billing_intervals":12,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_czjuNwSvWAQiCfgguhKKd"}}},"key":"Subscription - All Fields","summary":"Subscription - All Fields","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - All Fields"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Billing Cycle Day":{"value":{"id":"subscription_cB5ASNs5UywRavnmYRVy3","created_at":"2026-06-15T19:31:46.15Z","updated_at":"2026-06-15T19:31:46.15Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":1,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDs8jiuvHQwdKpdC7bj16MbG","instrument_id":"PIvEirFa32BxZWgsFyt8M7Q6","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-06-15T19:31:45.00Z","has_usage_based_plan":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":6,"day":15},"nickname":null,"start_subscription_at":"2026-06-15T19:30:45.479Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"EVERGREEN","subscription_plan_id":null,"tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cB5ASNs5UywRavnmYRVy3"}}},"key":"Subscription - Billing Cycle Day","summary":"Subscription - Billing Cycle Day","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Billing Cycle Day"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Discount Phase":{"value":{"id":"subscription_cxe8oDnBbKKDGMQQaWZca","created_at":"2026-02-17T18:38:50.28Z","updated_at":"2026-02-17T18:38:50.28Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","first_charge_at":"2026-02-17T18:38:50.00Z","next_billing_date":{"year":2026,"month":2,"day":17},"amount":2000,"buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"currency":"USD","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","nickname":"Finflix Gold Package","billing_interval":"MONTHLY","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":{"amount":1000,"billing_interval_count":3,"discount_phase_started_at":"2026-02-17T18:37:50.01Z","discount_phase_expected_start_at":"2026-02-17T18:37:50.01Z","discount_phase_expected_end_at":"2026-05-17T18:37:50.01Z"},"notification_preferences":{"send_confirmation":false}},"subscription_phase":"DISCOUNT","state":"ACTIVE","subscription_plan_id":null,"start_subscription_at":"2026-02-17T18:37:50.010Z","total_billing_intervals":null,"expires_at":null,"canceled_via":null,"tags":{},"subscription_link_id":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cxe8oDnBbKKDGMQQaWZca"}}},"key":"Subscription - Discount Phase","summary":"Subscription - Discount Phase","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Discount Phase"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length":{"value":{"id":"subscription_cxe8rTTPCwzUu7p1zmk6t","created_at":"2026-02-17T18:39:34.38Z","updated_at":"2026-02-17T18:39:34.38Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","first_charge_at":"2026-02-17T18:39:33.00Z","next_billing_date":{"year":2026,"month":2,"day":17},"amount":19900,"buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"currency":"USD","linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","nickname":null,"billing_interval":"MONTHLY","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_phase":"FIXED","state":"ACTIVE","subscription_plan_id":null,"start_subscription_at":"2026-02-17T18:38:33.747Z","total_billing_intervals":12,"expires_at":"2027-02-17T18:38:33.747Z","canceled_via":null,"tags":{},"subscription_link_id":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cxe8rTTPCwzUu7p1zmk6t"}}},"key":"Subscription - Fixed-Length","summary":"Subscription - Fixed-Length","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length - End Date":{"value":{"id":"subscription_cEQ6BbGxhCZuK8GcxWd7Z","created_at":"2026-10-08T16:37:27.96Z","updated_at":"2026-10-08T16:37:27.96Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":8,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","end_subscription_at":"2026-12-31T18:39:34.38Z","expires_at":"2026-12-31T18:39:34.380Z","first_charge_at":"2026-10-08T16:37:25.00Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":10,"day":8},"nickname":null,"start_subscription_at":"2026-10-08T16:36:25.591Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"FIXED","subscription_plan_id":null,"tags":{},"total_billing_intervals":3,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEQ6BbGxhCZuK8GcxWd7Z"}}},"key":"Subscription - Fixed-Length - End Date","summary":"Subscription - Fixed-Length - End Date","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Fixed-Length - End Date"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Future Start Date":{"value":{"id":"subscription_cEpKYiFpEsQsgnRhoAP5G","created_at":"2026-09-25T20:05:42.47Z","updated_at":"2026-09-25T20:05:42.47Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":1,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2027-06-01T00:00:00.00Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2027,"month":6,"day":1},"nickname":null,"start_subscription_at":"2027-06-01T00:00:00.000Z","state":"NOT_STARTED","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"NONE","subscription_plan_id":null,"tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEpKYiFpEsQsgnRhoAP5G"}}},"key":"Subscription - Future Start Date","summary":"Subscription - Future Start Date","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Future Start Date"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Trial Period":{"value":{"id":"subscription_cEpKYD3JD1iypyN3Vghiu","created_at":"2026-09-25T20:05:47.00Z","updated_at":"2026-09-25T20:05:47.00Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":25,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-10-25T20:05:46.00Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":10,"day":25},"nickname":null,"start_subscription_at":"2026-09-25T20:04:46.243Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":{"interval_type":"MONTH","interval_count":1,"trial_started_at":"2026-09-25T20:04:46.24Z","trial_expected_start_at":"2026-09-25T20:04:46.24Z","trial_expected_end_at":"2026-10-26T06:33:52.24Z"},"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"TRIAL","subscription_plan_id":null,"tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEpKYD3JD1iypyN3Vghiu"}}},"key":"Subscription - Trial Period","summary":"Subscription - Trial Period","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Trial Period"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields":{"value":{"id":"subscription_cEpKYaJUFhFVgoDGEELRq","created_at":"2026-09-25T20:05:40.61Z","updated_at":"2026-09-25T20:05:40.61Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":25,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-09-25T20:05:40.00Z","has_usage_based_plan":false,"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":9,"day":25},"nickname":null,"start_subscription_at":"2026-09-25T20:04:40.145Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"EVERGREEN","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE","tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEpKYaJUFhFVgoDGEELRq"}}},"key":"Subscription - Subscription Plan - Minimal Fields","summary":"Subscription - Subscription Plan - Minimal Fields","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Minimal Fields"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - All Fields":{"value":{"id":"subscription_cA2DeRbnuvrPQHK2HooT7","created_at":"2026-05-14T14:46:30.73Z","updated_at":"2026-05-14T14:46:30.73Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[{"type":"EMAIL","destinations":["abc@test.com"]},{"type":"SMS","destinations":["2348765431"]}],"shipping_address":{"city":"Middletown","country":"USA","line1":"324 Oak Avenue","line2":"Apartment 7","postal_code":"19734","region":"DE"}},"canceled_via":null,"currency":"USD","expires_at":"2028-06-01T00:00:00.000Z","first_charge_at":"2027-06-01T00:00:00.000Z","has_usage_based_plan":false,"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","next_billing_date":{"year":2027,"month":6,"day":1},"nickname":"Finflix Gold Package","start_subscription_at":"2027-06-01T00:00:00.000Z","state":"NOT_STARTED","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"NONE","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE","tags":{"order_number":"21DFASJSAKAS"},"total_billing_intervals":12,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cA2DeRbnuvrPQHK2HooT7"}}},"key":"Subscription - Subscription Plan - All Fields","summary":"Subscription - Subscription Plan - All Fields","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - All Fields"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length":{"value":{"id":"subscription_cxe8Sr7X43JeXoHTz3FgS","created_at":"2026-02-17T18:45:07.26Z","updated_at":"2026-02-17T18:45:07.26Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","first_charge_at":"2026-02-17T18:45:06.00Z","next_billing_date":{"year":2026,"month":2,"day":17},"amount":19900,"buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"currency":"USD","linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","nickname":null,"billing_interval":"MONTHLY","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_phase":"FIXED","state":"ACTIVE","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE","start_subscription_at":"2026-02-17T18:44:06.687Z","total_billing_intervals":12,"expires_at":"2027-02-17T18:44:06.687Z","canceled_via":null,"tags":{},"subscription_link_id":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cxe8Sr7X43JeXoHTz3FgS"}}},"key":"Subscription - Subscription Plan - Fixed-Length","summary":"Subscription - Subscription Plan - Fixed-Length","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date":{"value":{"id":"subscription_cEQ6srR7QNBc4qSXTmWPp","created_at":"2026-10-08T16:35:29.41Z","updated_at":"2026-10-08T16:35:29.41Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":8,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","end_subscription_at":"2026-12-31T18:45:07.26Z","expires_at":"2026-12-31T18:45:07.260Z","first_charge_at":"2026-10-08T16:35:28.00Z","has_usage_based_plan":false,"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":10,"day":8},"nickname":null,"start_subscription_at":"2026-10-08T16:34:28.713Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"FIXED","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE","tags":{},"total_billing_intervals":3,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEQ6srR7QNBc4qSXTmWPp"}}},"key":"Subscription - Subscription Plan - Fixed-Length - End Date","summary":"Subscription - Subscription Plan - Fixed-Length - End Date","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Fixed-Length - End Date"},"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date":{"value":{"id":"subscription_cEpKY3LYifPRVexiEJykd","created_at":"2026-09-25T20:05:38.98Z","updated_at":"2026-09-25T20:05:38.98Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":1,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2027-06-01T00:00:00.00Z","has_usage_based_plan":false,"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","next_billing_date":{"year":2027,"month":6,"day":1},"nickname":null,"start_subscription_at":"2027-06-01T00:00:00.000Z","state":"NOT_STARTED","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"NONE","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE","tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEpKY3LYifPRVexiEJykd"}}},"key":"Subscription - Subscription Plan - Future Start Date","summary":"Subscription - Subscription Plan - Future Start Date","id":"paths/~1subscriptions/post/responses/201/content/application~1json/examples/Subscription - Subscription Plan - Future Start Date"},"paths/~1subscriptions/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1subscriptions/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscriptions/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscriptions/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscriptions/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscriptions/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscriptions/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at and total_billing_intervals conflict":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6","message":"total_billing_intervals and end_subscription_at cannot be simultaneously used","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"end_subscription_at and total_billing_intervals conflict","summary":"end_subscription_at and total_billing_intervals conflict","id":"paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at and total_billing_intervals conflict"},"paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before subscription start":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7","message":"end_subscription_at must be after the subscription start","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"end_subscription_at before subscription start","summary":"end_subscription_at before subscription start","id":"paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before subscription start"},"paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before free trial end":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8","message":"end_subscription_at must be after the free trial end","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"end_subscription_at before free trial end","summary":"end_subscription_at before free trial end","id":"paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before free trial end"},"paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before discounted phase end":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9","message":"end_subscription_at must be after the discounted phase end","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"end_subscription_at before discounted phase end","summary":"end_subscription_at before discounted phase end","id":"paths/~1subscriptions/post/responses/422/content/application~1json/examples/end_subscription_at before discounted phase end"},"paths/~1subscriptions/get/responses/200/content/application~1json/examples/List of Subscriptions":{"value":{"_embedded":{"subscriptions":[{"id":"subscription_cEpEvntLMkCzF4DvP9ngF","created_at":"2026-09-25T18:54:02.97Z","updated_at":"2026-09-25T18:54:15.38Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":25,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-10-25T18:54:02.00Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":10,"day":25},"nickname":null,"start_subscription_at":"2026-09-25T18:53:02.381Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":{"interval_type":"MONTH","interval_count":1,"trial_started_at":"2026-09-25T18:53:02.38Z","trial_expected_start_at":"2026-09-25T18:53:02.38Z","trial_expected_end_at":"2026-10-26T05:22:08.38Z"},"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"TRIAL","subscription_plan_id":null,"tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEpEvntLMkCzF4DvP9ngF"}}},{"id":"subscription_cEpEveeVmWugJ8AGkT66u","created_at":"2026-09-25T18:54:01.04Z","updated_at":"2026-09-25T18:54:14.93Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":25,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-09-25T18:54:00.00Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":10,"day":25},"nickname":null,"start_subscription_at":"2026-09-25T18:53:00.439Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"EVERGREEN","subscription_plan_id":null,"tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEpEveeVmWugJ8AGkT66u"}}},{"id":"subscription_cEpEuXkXhvHE5V3ov6DVN","created_at":"2026-09-25T18:53:57.33Z","updated_at":"2026-09-25T18:54:11.87Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":25,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-09-25T18:53:57.00Z","has_usage_based_plan":false,"linked_to":"MUxdJCr9xTMnmt1vGUAqV9z4","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":10,"day":25},"nickname":null,"start_subscription_at":"2026-09-25T18:52:57.064Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"EVERGREEN","subscription_plan_id":"subscription_plan_ctBbJ1ihsC8Hpju4RQfZE","tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cEpEuXkXhvHE5V3ov6DVN"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions?limit=3&state=ACTIVE"},"next":{"href":"https://finix.sandbox-payments-api.com/subscriptions?limit=3&state=ACTIVE&after_cursor=subscription_cEpEuXkXhvHE5V3ov6DVN"}},"page":{"limit":3,"next_cursor":"subscription_cEpEuXkXhvHE5V3ov6DVN"}},"key":"List of Subscriptions","summary":"List of Subscriptions","id":"paths/~1subscriptions/get/responses/200/content/application~1json/examples/List of Subscriptions"},"paths/~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscriptions/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscriptions/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscriptions/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscriptions/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscriptions/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscriptions/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1subscriptions/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1subscriptions~1{subscription_id}/get/responses/200/content/application~1json/examples/Subscription":{"value":{"id":"subscription_czjuNwSvWAQiCfgguhKKd","created_at":"2026-04-22T21:11:31.12Z","updated_at":"2026-04-22T21:11:31.12Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[{"type":"EMAIL","destinations":["abc@test.com"]},{"type":"SMS","destinations":["2348765431"]}],"shipping_address":{"city":"Middletown","country":"USA","line1":"324 Oak Avenue","line2":"Apartment 7","postal_code":"19734","region":"DE"}},"canceled_via":null,"currency":"USD","expires_at":"2028-08-01T00:00:00.000Z","first_charge_at":"2027-08-01T00:00:00.000Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2027,"month":8,"day":1},"nickname":"Finflix Gold Package","start_subscription_at":"2027-06-01T00:00:00.000Z","state":"NOT_STARTED","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":{"interval_type":"MONTH","interval_count":2,"trial_started_at":null,"trial_expected_start_at":"2027-06-01T00:00:00.000Z","trial_expected_end_at":"2027-08-01T00:00:00.000Z"},"discount_phase_details":{"amount":1000,"billing_interval_count":3,"discount_phase_started_at":null,"discount_phase_expected_start_at":"2027-08-01T00:00:00.000Z","discount_phase_expected_end_at":"2027-11-01T00:00:00.000Z"},"notification_preferences":{"send_confirmation":true}},"subscription_link_id":null,"subscription_phase":"NONE","subscription_plan_id":null,"tags":{"order_number":"21DFASJSAKAS"},"total_billing_intervals":12,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_czjuNwSvWAQiCfgguhKKd"}}},"key":"Subscription","summary":"Subscription","id":"paths/~1subscriptions~1{subscription_id}/get/responses/200/content/application~1json/examples/Subscription"},"paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscriptions~1{subscription_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscriptions~1{subscription_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"subscription_cvTpAt87A4hncnuC4rkh6 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1subscriptions~1{subscription_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1subscriptions~1{subscription_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscriptions~1{subscription_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription":{"value":{"amount":12000,"buyer_details":{"instrument_id":"PIc6kMBvJB5CfHvBXRuRwwtU","requested_delivery_methods":[{"destinations":["test@gmail.com"],"type":"EMAIL"}],"shipping_address":{"city":"Middletown","country":"USA","line1":"324 Oak Avenue","line2":"Apartment 7","postal_code":"19734","region":"DE"}},"nickname":"Finflix Gold Package","subscription_details":{"send_invoice":true,"send_receipt":true},"tags":{"package":"gold"}},"key":"Update Subscription","summary":"Update Subscription","id":"paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription"},"paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - Billing Cycle Day":{"value":{"billing_cycle_day":1},"key":"Update Subscription - Billing Cycle Day","summary":"Update Subscription - Billing Cycle Day","id":"paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - Billing Cycle Day"},"paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - New Subscription Plan":{"value":{"subscription_plan_id":"subscription_plan_cqsXxZf3Qd6ieEYEipM9Y"},"key":"Update Subscription - New Subscription Plan","summary":"Update Subscription - New Subscription Plan","id":"paths/~1subscriptions~1{subscription_id}/put/requestBody/content/application~1json/examples/Update Subscription - New Subscription Plan"},"paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription":{"value":{"id":"subscription_cvTpAt87A4hncnuC4rkh6","created_at":"2026-01-07T17:24:59.20Z","updated_at":"2026-06-11T22:26:30.72Z","amount":12000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDsbrL4KWzTRiZB3nNgoHR8q","instrument_id":"PIc6kMBvJB5CfHvBXRuRwwtU","requested_delivery_methods":[{"type":"EMAIL","destinations":["test@gmail.com"]}],"shipping_address":{"city":"Middletown","country":"USA","line1":"324 Oak Avenue","line2":"Apartment 7","postal_code":"19734","region":"DE"}},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-01-07T17:24:58.00Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":7,"day":7},"nickname":"Finflix Gold Package","start_subscription_at":"2026-01-07T17:23:58.856Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":true,"send_receipt":true,"trial_details":null,"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":"subscription_link_cvTp2K5CNH9Lr4BqCphcM","subscription_phase":"EVERGREEN","subscription_plan_id":"subscription_plan_cmsyQKfkpSEtUVfvxr9Dc","tags":{"package":"gold"},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}},"key":"Update Subscription","summary":"Update Subscription","id":"paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription"},"paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - Billing Cycle Day":{"value":{"id":"subscription_cAqNtRY2oKTJWbjMSDgrk","created_at":"2026-05-26T20:21:22.16Z","updated_at":"2026-09-25T20:05:47.31Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_cycle_day":1,"billing_interval":"MONTHLY","buyer_details":{"identity_id":"IDtEnKsZyJNUGK83ZTx4C45S","instrument_id":"PImXAVgkKVshKWWHUk4xXbve","requested_delivery_methods":[],"shipping_address":null},"canceled_via":null,"currency":"USD","expires_at":null,"first_charge_at":"2026-06-26T20:21:21.00Z","has_usage_based_plan":false,"linked_to":"MUcgYZswyRfqSSbvMsxuaHxZ","linked_type":"MERCHANT","next_billing_date":{"year":2026,"month":6,"day":26},"nickname":null,"start_subscription_at":"2026-05-26T20:20:21.863Z","state":"ACTIVE","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":{"interval_type":"MONTH","interval_count":1,"trial_started_at":"2026-05-26T20:20:21.86Z","trial_expected_start_at":"2026-05-26T20:20:21.86Z","trial_expected_end_at":"2026-06-26T06:49:27.86Z"},"discount_phase_details":null,"notification_preferences":{"send_confirmation":false}},"subscription_link_id":null,"subscription_phase":"EVERGREEN","subscription_plan_id":null,"tags":{},"total_billing_intervals":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cAqNtRY2oKTJWbjMSDgrk"}}},"key":"Update Subscription - Billing Cycle Day","summary":"Update Subscription - Billing Cycle Day","id":"paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - Billing Cycle Day"},"paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - New Subscription Plan":{"value":{"id":"subscription_ctnvvR3JQvj8ZS6TtJXLh","created_at":"2025-10-22T15:55:52.67Z","updated_at":"2025-10-22T15:55:52.67Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","first_charge_at":"2025-10-22T15:55:52.00Z","next_billing_date":{"year":2025,"month":10,"day":22},"amount":19900,"buyer_details":{"identity_id":"IDsuVDUYpUS2pzqQVsuUZzNH","instrument_id":"PIjRceA8GheFS4Dd72hShqZ3","requested_delivery_methods":[],"shipping_address":null},"currency":"USD","linked_to":"MUmKTKuetVV1MQ5Cq6rjWA5j","linked_type":"MERCHANT","nickname":null,"billing_interval":"MONTHLY","subscription_details":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false,"trial_details":{"interval_type":"MONTH","interval_count":2,"trial_started_at":"2025-01-01T00:00:00.00Z","trial_expected_end_at":"2025-03-01T00:00:00.00Z"},"discount_phase_details":{"amount":1000,"billing_interval_count":3},"notification_preferences":{"send_confirmation":false}},"subscription_phase":"EVERGREEN","state":"ACTIVE","subscription_plan_id":"subscription_plan_cqsXxZf3Qd6ieEYEipM9Y","start_subscription_at":"2025-10-22T15:54:52.404Z","total_billing_intervals":null,"expires_at":null,"canceled_via":null,"tags":{},"subscription_link_id":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_ctnvvR3JQvj8ZS6TtJXLh"}}},"key":"Update Subscription - New Subscription Plan","summary":"Update Subscription - New Subscription Plan","id":"paths/~1subscriptions~1{subscription_id}/put/responses/200/content/application~1json/examples/Update Subscription - New Subscription Plan"},"paths/~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1subscriptions~1{subscription_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscriptions~1{subscription_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscriptions~1{subscription_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"subscription_cvTpAt87A4hncnuC4rkh6 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1subscriptions~1{subscription_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1subscriptions~1{subscription_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscriptions~1{subscription_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"subscription_cvTpAt87A4hncnuC4rkh6 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/404/content/application~1json/examples/Not found"},"paths/~1subscriptions~1{subscription_id}/delete/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscriptions~1{subscription_id}/delete/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/requestBody/content/application~1json/examples/Subscription Balance Entry":{"value":{"amount":1000,"currency":"USD","description":"Applying a credit since I accidentally overcharged this subscription.","tags":{},"type":"CREDIT"},"key":"Subscription Balance Entry","summary":"Subscription Balance Entry","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/requestBody/content/application~1json/examples/Subscription Balance Entry"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/201/content/application~1json/examples/Subscription Balance Entry":{"value":{"id":"subscription_balance_entry_cEpKXWi2GyAZdCVWhuC8v","created_at":"2026-09-25T20:05:37.47Z","updated_at":"2026-09-25T20:05:37.47Z","amount":1000,"currency":"USD","description":"Applying a credit since I accidentally overcharged this subscription.","subscription_id":"subscription_cAqNtRY2oKTJWbjMSDgrk","tags":{},"type":"CREDIT"},"key":"Subscription Balance Entry","summary":"Subscription Balance Entry","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/201/content/application~1json/examples/Subscription Balance Entry"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/200/content/application~1json/examples/List of Subscription Balance Entries":{"value":{"_embedded":{"subscription_balance_entries":[{"id":"subscription_balance_entry_czM1i9keffyXNVr3J9TzA","created_at":"2026-05-06T21:13:43.96Z","updated_at":"2026-05-06T21:21:33.88Z","amount":1000,"currency":"USD","description":"Applying a credit since I accidentally overcharged this subscription.","subscription_id":"subscription_cvTpAt87A4hncnuC4rkh6","tags":{"internal_code":"1234E"},"type":"CREDIT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balances"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries?limit=3&after_cursor=subscription_balance_entry_czM1i9keffyXNVr3J9TzA"}},"page":{"limit":3,"next_cursor":"subscription_balance_entry_czM1i9keffyXNVr3J9TzA"}},"key":"List of Subscription Balance Entries","summary":"List of Subscription Balance Entries","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/200/content/application~1json/examples/List of Subscription Balance Entries"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"subscription_cvTpAt87A4hncnuC4rkh6 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/404/content/application~1json/examples/Not found"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/200/content/application~1json/examples/Subscription Balance Entry":{"value":{"id":"subscription_balance_entry_cEpKXWi2GyAZdCVWhuC8v","created_at":"2026-09-25T20:05:37.47Z","updated_at":"2026-09-25T20:05:37.47Z","amount":1000,"currency":"USD","description":"Applying a credit since I accidentally overcharged this subscription.","subscription_id":"subscription_cAqNtRY2oKTJWbjMSDgrk","tags":{},"type":"CREDIT"},"key":"Subscription Balance Entry","summary":"Subscription Balance Entry","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/200/content/application~1json/examples/Subscription Balance Entry"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries/subscription_balance_entry_czM1i9keffyXNVr3J9TzA"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries/subscription_balance_entry_czM1i9keffyXNVr3J9TzA"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries/subscription_balance_entry_czM1i9keffyXNVr3J9TzA"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"subscription_balance_entry_czM1i9keffyXNVr3J9TzA was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries/subscription_balance_entry_czM1i9keffyXNVr3J9TzA"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscriptions/subscription_cvTpAt87A4hncnuC4rkh6/subscription_balance_entries/subscription_balance_entry_czM1i9keffyXNVr3J9TzA"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscriptions~1{subscription_id}~1subscription_balance_entries~1{subscription_balance_entry_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan":{"value":{"amount":19900,"billing_defaults":{"collection_method":"BILL_AUTOMATICALLY"},"billing_interval":"MONTHLY","currency":"USD","description":"A basic API portal account with the least features.","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","plan_name":"API portal - Basic"},"key":"Subscription Plan","summary":"Subscription Plan","id":"paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan"},"paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Default Duration":{"value":{"amount":10000,"billing_defaults":{"collection_method":"BILL_AUTOMATICALLY"},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":12,"description":"A basic API portal account with the least features.","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","plan_name":"API portal - Basic"},"key":"Subscription Plan with Default Duration","summary":"Subscription Plan with Default Duration","id":"paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Default Duration"},"paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Discount Phase":{"value":{"amount":10000,"billing_defaults":{"collection_method":"BILL_AUTOMATICALLY"},"billing_interval":"MONTHLY","currency":"USD","description":"A basic API portal account with the least features.","discount_phase_defaults":{"amount":1000,"billing_interval_count":3},"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","plan_name":"API portal - Basic"},"key":"Subscription Plan with Discount Phase","summary":"Subscription Plan with Discount Phase","id":"paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Discount Phase"},"paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Trial Phase":{"value":{"amount":10000,"billing_defaults":{"collection_method":"BILL_AUTOMATICALLY"},"billing_interval":"MONTHLY","currency":"USD","description":"A basic API portal account with the least features.","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","plan_name":"API portal - Basic","trial_defaults":{"interval_count":1,"interval_type":"DAY"}},"key":"Subscription Plan with Trial Phase","summary":"Subscription Plan with Trial Phase","id":"paths/~1subscription_plans/post/requestBody/content/application~1json/examples/Subscription Plan with Trial Phase"},"paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan":{"value":{"id":"subscription_plan_cxe9qEwtKZNm2g2imRqB6","created_at":"2026-02-17T18:52:24.51Z","updated_at":"2026-02-17T18:52:24.51Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","billing_interval":"MONTHLY","nickname":null,"plan_name":"API portal - Basic","description":"A basic API portal account with the least features.","amount":19900,"currency":"USD","duration_type":"EVERGREEN","default_total_billing_intervals":null,"billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"trial_defaults":null,"discount_phase_defaults":null,"state":"ACTIVE","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cxe9qEwtKZNm2g2imRqB6"}}},"key":"Subscription Plan","summary":"Subscription Plan","id":"paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan"},"paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Default Duration":{"value":{"id":"subscription_plan_cEpKXs2r1TGALtrCBn6r8","created_at":"2026-09-25T20:05:30.86Z","updated_at":"2026-09-25T20:05:30.86Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":12,"description":"A basic API portal account with the least features.","discount_phase_defaults":null,"duration_type":"EVERGREEN","is_usage_based":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","nickname":null,"plan_name":"API portal - Basic","state":"ACTIVE","tags":{},"trial_defaults":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cEpKXs2r1TGALtrCBn6r8"}},"billing_items":[]},"key":"Subscription Plan with Default Duration","summary":"Subscription Plan with Default Duration","id":"paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Default Duration"},"paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Discount Phase":{"value":{"id":"subscription_plan_cEpKXwCeZzDWoURHimGh7","created_at":"2026-09-25T20:05:31.93Z","updated_at":"2026-09-25T20:05:31.93Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":null,"description":"A basic API portal account with the least features.","discount_phase_defaults":{"amount":1000,"billing_interval_count":3},"duration_type":"EVERGREEN","is_usage_based":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","nickname":null,"plan_name":"API portal - Basic","state":"ACTIVE","tags":{},"trial_defaults":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cEpKXwCeZzDWoURHimGh7"}},"billing_items":[]},"key":"Subscription Plan with Discount Phase","summary":"Subscription Plan with Discount Phase","id":"paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Discount Phase"},"paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Trial Phase":{"value":{"id":"subscription_plan_cEpKXycfmEoZo3Bf3SC1R","created_at":"2026-09-25T20:05:32.30Z","updated_at":"2026-09-25T20:05:32.30Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":null,"description":"A basic API portal account with the least features.","discount_phase_defaults":null,"duration_type":"EVERGREEN","is_usage_based":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","nickname":null,"plan_name":"API portal - Basic","state":"ACTIVE","tags":{},"trial_defaults":{"interval_type":"DAY","interval_count":1},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cEpKXycfmEoZo3Bf3SC1R"}},"billing_items":[]},"key":"Subscription Plan with Trial Phase","summary":"Subscription Plan with Trial Phase","id":"paths/~1subscription_plans/post/responses/201/content/application~1json/examples/Subscription Plan with Trial Phase"},"paths/~1subscription_plans/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1subscription_plans/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1subscription_plans/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscription_plans/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscription_plans/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscription_plans/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscription_plans/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscription_plans/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscription_plans/get/responses/200/content/application~1json/examples/List of Subscription Plans":{"value":{"_embedded":{"subscription_plans":[{"id":"subscription_plan_cEpKXycfmEoZo3Bf3SC1R","created_at":"2026-09-25T20:05:32.30Z","updated_at":"2026-09-25T20:05:32.30Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":null,"description":"A basic API portal account with the least features.","discount_phase_defaults":null,"duration_type":"EVERGREEN","is_usage_based":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","nickname":null,"plan_name":"API portal - Basic","product_pricing_configurations":null,"state":"ACTIVE","tags":{},"trial_defaults":{"interval_type":"DAY","interval_count":1},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cEpKXycfmEoZo3Bf3SC1R"}}},{"id":"subscription_plan_cEpKXwCeZzDWoURHimGh7","created_at":"2026-09-25T20:05:31.93Z","updated_at":"2026-09-25T20:05:31.93Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":null,"description":"A basic API portal account with the least features.","discount_phase_defaults":{"amount":1000,"billing_interval_count":3},"duration_type":"EVERGREEN","is_usage_based":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","nickname":null,"plan_name":"API portal - Basic","product_pricing_configurations":null,"state":"ACTIVE","tags":{},"trial_defaults":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cEpKXwCeZzDWoURHimGh7"}}},{"id":"subscription_plan_cEpKXs2r1TGALtrCBn6r8","created_at":"2026-09-25T20:05:30.86Z","updated_at":"2026-09-25T20:05:30.86Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":12,"description":"A basic API portal account with the least features.","discount_phase_defaults":null,"duration_type":"EVERGREEN","is_usage_based":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","nickname":null,"plan_name":"API portal - Basic","product_pricing_configurations":null,"state":"ACTIVE","tags":{},"trial_defaults":null,"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cEpKXs2r1TGALtrCBn6r8"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans?limit=3&state=ACTIVE"},"next":{"href":"https://finix.sandbox-payments-api.com/subscription_plans?limit=3&state=ACTIVE&after_cursor=subscription_plan_cEpKXs2r1TGALtrCBn6r8"}},"page":{"limit":3,"next_cursor":"subscription_plan_cEpKXs2r1TGALtrCBn6r8"}},"key":"List of Subscription Plans","summary":"List of Subscription Plans","id":"paths/~1subscription_plans/get/responses/200/content/application~1json/examples/List of Subscription Plans"},"paths/~1subscription_plans/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscription_plans/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscription_plans/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscription_plans/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscription_plans/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscription_plans/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscription_plans/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1subscription_plans/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/200/content/application~1json/examples/Subscription Plan":{"value":{"id":"subscription_plan_cxe9qEwtKZNm2g2imRqB6","created_at":"2026-02-17T18:52:24.51Z","updated_at":"2026-02-17T18:52:24.51Z","application_id":"APc9vhYcPsRuTSpKD9KpMtPe","linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","billing_interval":"MONTHLY","nickname":null,"plan_name":"API portal - Basic","description":"A basic API portal account with the least features.","amount":19900,"currency":"USD","duration_type":"EVERGREEN","default_total_billing_intervals":null,"billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"trial_defaults":null,"discount_phase_defaults":null,"state":"ACTIVE","tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cxe9qEwtKZNm2g2imRqB6"}}},"key":"Subscription Plan","summary":"Subscription Plan","id":"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/200/content/application~1json/examples/Subscription Plan"},"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"subscription_plan_ciLn19pSKDTFoehtH7ETg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscription_plans~1{subscription_plan_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Update Subscription Plan":{"value":{"amount":19900,"description":"A starter plan with minimal features","nickname":"API portal - Basic plan","tags":{"order_number":"21DFASJSAKAS"},"update_existing_subscriptions":true},"key":"Update Subscription Plan","summary":"Update Subscription Plan","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Update Subscription Plan"},"paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Deactivate Subscription Plan":{"value":{"amount":19900,"description":"A basic API portal account with the least features.","nickname":"API portal - Basic","state":"INACTIVE","update_existing_subscriptions":true},"key":"Deactivate Subscription Plan","summary":"Deactivate Subscription Plan","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/requestBody/content/application~1json/examples/Deactivate Subscription Plan"},"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Update Subscription Plan":{"value":{"id":"subscription_plan_cAqNsG7EbVUgqvV3JGhR7","created_at":"2026-05-26T20:21:06.29Z","updated_at":"2026-09-25T20:05:35.01Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":null,"description":"A starter plan with minimal features","discount_phase_defaults":null,"duration_type":"EVERGREEN","is_usage_based":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","nickname":"API portal - Basic plan","plan_name":"API portal - Basic","state":"INACTIVE","tags":{"order_number":"21DFASJSAKAS"},"trial_defaults":{"interval_type":"DAY","interval_count":30},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cAqNsG7EbVUgqvV3JGhR7"}},"billing_items":[]},"key":"Update Subscription Plan","summary":"Update Subscription Plan","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Update Subscription Plan"},"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Deactivate Subscription Plan":{"value":{"id":"subscription_plan_cAqNsG7EbVUgqvV3JGhR7","created_at":"2026-05-26T20:21:06.29Z","updated_at":"2026-09-25T20:05:33.10Z","amount":19900,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","billing_defaults":{"collection_method":"BILL_AUTOMATICALLY","send_invoice":false,"send_receipt":false},"billing_interval":"MONTHLY","currency":"USD","default_total_billing_intervals":null,"description":"A basic API portal account with the least features.","discount_phase_defaults":null,"duration_type":"EVERGREEN","is_usage_based":false,"linked_to":"MUwfZPNW3r4EqLMzwgr6txw4","linked_type":"MERCHANT","nickname":"API portal - Basic","plan_name":"API portal - Basic","state":"INACTIVE","tags":{"order_number":"21DFASJSAKAS"},"trial_defaults":{"interval_type":"DAY","interval_count":30},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_cAqNsG7EbVUgqvV3JGhR7"}},"billing_items":[]},"key":"Deactivate Subscription Plan","summary":"Deactivate Subscription Plan","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/200/content/application~1json/examples/Deactivate Subscription Plan"},"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/400/content/application~1json/examples/Malformed request"},"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"subscription_plan_ciLn19pSKDTFoehtH7ETg was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/404/content/application~1json/examples/Not found"},"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/subscription_plans/subscription_plan_ciLn19pSKDTFoehtH7ETg"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1subscription_plans~1{subscription_plan_id}/put/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfer_attempts/get/responses/200/content/application~1json/examples/List of Transfer Attempts":{"value":{"_embedded":{"transfer_attempts":[{"id":"transfer_attempt_cE7L9Ryh2vpyFMhKmjGDR","created_at":"2026-09-16T20:37:59.55Z","updated_at":"2026-09-16T20:37:59.55Z","additional_buyer_charges":null,"amount":2750,"amount_requested":2750,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","authorization_id":null,"buyer_details":{"billing_address":null,"email":"asdasdasd@google.com","first_name":"asdasd","identity_id":"IDbGYFHcZPp1EZ3K8Dhe26xW","last_name":"","phone":null,"shipping_address":{"city":"sdasdadas","country":"USA","line1":"asda","line2":"asd","postal_code":"31245","region":"AL"}},"currency":"USD","entity_id":"checkout_form_cE7L5ZrVhPvUxa52CMQs9","entity_type":"CHECKOUT_FORM","failure_code":null,"failure_message":null,"is_authorization":false,"merchant_id":"MUmfEGv5bMpSJ9k5TFRUjkmm","microdeposit_verification_url":null,"operation_key":"SALE","payment_frequency":"ONE_TIME","payment_instrument_id":"PIUJBqMET1vHRcDSA9too5s","pending_code":null,"pending_message":null,"receipt_requested_delivery_methods":[],"recipient_details":null,"recipient_merchant_id":null,"state":"SUCCEEDED","statement_descriptor":null,"tags":{},"transfer_id":"TRgVLB8jtuLj3gdNmPLY3uCU","type":"DEBIT"},{"id":"transfer_attempt_cDXNyNtQVxK7PaHctToJr","created_at":"2026-09-12T03:04:17.21Z","updated_at":"2026-09-12T03:04:17.21Z","additional_buyer_charges":{"convenience_amount":null,"rent_surcharge_amount":null,"surcharge_amount":1000},"amount":6500,"amount_requested":7500,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","authorization_id":null,"buyer_details":{"billing_address":null,"email":"test@test.com","first_name":"Abhishek","identity_id":"IDreSY5nezoUVD6zqDdnE2CG","last_name":"","phone":null,"shipping_address":{"city":null,"country":"USA","line1":null,"line2":null,"postal_code":null,"region":null}},"currency":"USD","entity_id":"payment_link_cDXNpkbh3ZrgB313fnrwe","entity_type":"PAYMENT_LINK","failure_code":null,"failure_message":null,"is_authorization":false,"merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","microdeposit_verification_url":null,"operation_key":"SALE","payment_frequency":"ONE_TIME","payment_instrument_id":"PI62GbsaByq92eAd6QsSqhzr","pending_code":null,"pending_message":null,"receipt_requested_delivery_methods":[],"recipient_details":null,"recipient_merchant_id":null,"state":"SUCCEEDED","statement_descriptor":null,"tags":{},"transfer_id":"TRme7YXcFzcdSN1C3YCdQnvh","type":"DEBIT"},{"id":"transfer_attempt_cDEeAA1UoQbXEY8Abrj85","created_at":"2026-09-02T20:21:50.28Z","updated_at":"2026-09-02T20:21:50.28Z","additional_buyer_charges":null,"amount":2750,"amount_requested":2750,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","authorization_id":null,"buyer_details":{"billing_address":null,"email":"jondoe@gmail.com","first_name":"John","identity_id":"IDpZQMDc8jZuijvPzEAq5DnU","last_name":"doe","phone":null,"shipping_address":{"city":"Orlando","country":"USA","line1":"123 Main St","line2":null,"postal_code":"23827","region":"FL"}},"currency":"USD","entity_id":"checkout_form_cDEeuopeiBSRjTTF3SAag","entity_type":"CHECKOUT_FORM","failure_code":null,"failure_message":null,"is_authorization":false,"merchant_id":"MUmfEGv5bMpSJ9k5TFRUjkmm","microdeposit_verification_url":null,"operation_key":"SALE","payment_frequency":"ONE_TIME","payment_instrument_id":"PIsZAmfsidUi3iNPv7EjTTso","pending_code":null,"pending_message":null,"receipt_requested_delivery_methods":[],"recipient_details":null,"recipient_merchant_id":null,"state":"SUCCEEDED","statement_descriptor":null,"tags":{},"transfer_id":"TRvk11wHmwixbFCjksyYhTQh","type":"DEBIT"}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts?limit=3&state=SUCCEEDED"},"next":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts?limit=3&state=SUCCEEDED&after_cursor=transfer_attempt_cDEeAA1UoQbXEY8Abrj85"}},"page":{"limit":3,"next_cursor":"transfer_attempt_cDEeAA1UoQbXEY8Abrj85"}},"key":"List of Transfer Attempts","summary":"List of Transfer Attempts","id":"paths/~1transfer_attempts/get/responses/200/content/application~1json/examples/List of Transfer Attempts"},"paths/~1transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1transfer_attempts/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1transfer_attempts/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1transfer_attempts/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts"}}}]}},"key":"Invalid query param value","summary":"Invalid query param value","id":"paths/~1transfer_attempts/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Checkout Form":{"value":{"id":"transfer_attempt_ciADTi3MFTjJdrCuvoNZk","created_at":"2024-12-27T06:08:45.23Z","updated_at":"2024-12-27T06:08:45.23Z","amount":5418,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","buyer_details":{"first_name":"John","last_name":"Smith","email":"john.smith@gmail.com","identity_id":"IDkw7UhEWpBXpzSkwi3GtzeB","phone":null,"billing_address":null,"shipping_address":{"city":"San Francisco","country":"USA","line1":"741 Douglass Street","line2":null,"postal_code":"94114","region":"CA"}},"currency":"USD","entity_id":"checkout_form_ciADaDNMFAHdyNbDPuByS","entity_type":"CHECKOUT_FORM","failure_code":null,"failure_message":null,"merchant_id":"MUmfEGv5bMpSJ9k5TFRUjkmm","microdeposit_verification_url":null,"operation_key":"SALE","payment_frequency":"ONE_TIME","payment_instrument_id":"PI7m5SAdXgkLYRDKmjiYfDgy","pending_code":null,"pending_message":null,"receipt_requested_delivery_methods":[],"recipient_details":null,"recipient_merchant_id":null,"state":"SUCCEEDED","tags":{},"transfer_id":"TRRM1Gf9q8iXB22yZNviNPZ","type":"DEBIT"},"key":"Transfer Attempt - Checkout Form","summary":"Transfer Attempt - Checkout Form","id":"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Checkout Form"},"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payment Link":{"value":{"id":"transfer_attempt_cvRBHXQm6PPj25xpR55Nw","additional_buyer_charges":{"convenience_amount":1000,"rent_surcharge_amount":null,"surcharge_amount":null},"amount":6418,"amount_requested":6418,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","authorization_id":null,"buyer_details":{"billing_address":null,"email":"johndoe@gmail.com","first_name":"John","identity_id":"IDsjnoZb6VcRhGKNP29QFXtc","last_name":"Doe","phone":null,"shipping_address":null},"created_at":"2026-01-06T18:42:51.43Z","currency":"USD","entity_id":"payment_link_cvRyr3csBjSNgvpHq5wLN","entity_type":"PAYMENT_LINK","failure_code":null,"failure_message":null,"is_authorization":false,"merchant_id":"MU7noQ1wdgdAeAfymw2rfBMq","microdeposit_verification_url":null,"operation_key":"SALE","payment_frequency":"ONE_TIME","payment_instrument_id":"PIxhcKmEfLUrLAJbbwWKJ6vD","pending_code":null,"pending_message":null,"receipt_requested_delivery_methods":[{"type":"EMAIL","destinations":["johndoe@gmail.com"]}],"recipient_details":{"business_address":null,"business_name":null,"doing_business_as":null,"email":null,"first_name":null,"last_name":null,"personal_address":null,"phone":null,"type":null},"recipient_merchant_id":null,"state":"SUCCEEDED","tags":{},"transfer_id":"TRgQ7h45L2PUrz3QNNNg2Unh","type":"DEBIT","updated_at":"2026-01-06T18:42:51.43Z"},"key":"Transfer Attempt - Payment Link","summary":"Transfer Attempt - Payment Link","id":"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payment Link"},"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payout Link":{"value":{"id":"transfer_attempt_ciAFQyjswrHwctwuXPBRs","created_at":"2024-12-27T06:34:21.75Z","updated_at":"2024-12-27T06:35:03.14Z","amount":100000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","buyer_details":null,"currency":"USD","entity_id":"payout_link_ciAFzb3QvDyNUfZN6Hqwe","entity_type":"PAYOUT_LINK","failure_code":null,"failure_message":null,"merchant_id":null,"microdeposit_verification_url":null,"operation_key":"PUSH_TO_CARD","payment_frequency":null,"payment_instrument_id":"PIiYHJ6dDykz1fihySDWzxd4","pending_code":null,"pending_message":null,"receipt_requested_delivery_methods":[],"recipient_details":{"type":"PERSONAL","business_name":null,"doing_business_as":null,"first_name":"Bernie","last_name":"Bingbob","email":null,"phone":null,"personal_address":{"city":"Portland","country":"USA","line1":"783 Southeast 185th Avenue","line2":null,"postal_code":"97233","region":"OR"},"business_address":{"city":null,"country":"USA","line1":null,"line2":null,"postal_code":null,"region":null}},"recipient_merchant_id":"MUt6kBb22rxUvWNxUf8XriB2","state":"SUCCEEDED","tags":{},"transfer_id":"TRo9MsQ6Li9NYbYXuHrhY4kC","type":"CREDIT"},"key":"Transfer Attempt - Payout Link","summary":"Transfer Attempt - Payout Link","id":"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/200/content/application~1json/examples/Transfer Attempt - Payout Link"},"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts/transfer_attempt_ciACBK59kDhfx2Mi4Vy81"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts/transfer_attempt_ciACBK59kDhfx2Mi4Vy81"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/404/content/application~1json/examples/Not Found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"transfer_attempt_ciACBK59kDhfx2Mi4Vy81 was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts/transfer_attempt_ciACBK59kDhfx2Mi4Vy81"}}}]}},"key":"Not Found","summary":"Not Found","id":"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/404/content/application~1json/examples/Not Found"},"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/transfer_attempts/transfer_attempt_ciACBK59kDhfx2Mi4Vy81"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1transfer_attempts~1{transfer_attempt_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1balances/get/responses/200/content/application~1json/examples/List of Balances":{"value":{"_embedded":{"balances":[{"id":"balance_dyz5APsJebDef9oTW9J2Hc","created_at":"2024-11-14T22:25:48.01Z","updated_at":"2024-11-14T22:25:48.01Z","available_amount":4236592,"currency":"USD","linked_to":null,"linked_type":"APPLICATION","pending_amount":4236592,"posted_amount":4236592,"tags":{"created_via":"SYSTEM","description":"BrainTree"},"type":"DISBURSEMENT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances?limit=3"}},"page":{"limit":3,"next_cursor":"balance_dyz5APsJebDef9oTW9J2Hc"}},"key":"List of Balances","summary":"List of Balances","id":"paths/~1balances/get/responses/200/content/application~1json/examples/List of Balances"},"paths/~1balances/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1balances/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1balances/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1balances/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1balances/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1balances/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1balances/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1balances/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1balances~1{balance_id}/get/responses/200/content/application~1json/examples/Balance":{"value":{"id":"balance_dyz5APsJebDef9oTW9J2Hc","created_at":"2024-11-14T22:25:48.01Z","updated_at":"2024-11-14T22:25:48.01Z","available_amount":4236592,"currency":"USD","linked_to":"APc9vhYcPsRuTSpKD9KpMtPe","linked_type":"APPLICATION","pending_amount":4236592,"posted_amount":4236592,"tags":{"created_via":"SYSTEM","description":"BrainTree"},"type":"DISBURSEMENT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc"}}},"key":"Balance","summary":"Balance","id":"paths/~1balances~1{balance_id}/get/responses/200/content/application~1json/examples/Balance"},"paths/~1balances~1{balance_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1balances~1{balance_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1balances~1{balance_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1balances~1{balance_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1balances~1{balance_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"balance_dyz5APsJebDef9oTW9J2Hc was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1balances~1{balance_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1balances~1{balance_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1balances~1{balance_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1balances~1{balance_id}~1balance_entries/get/responses/200/content/application~1json/examples/List of Balances":{"value":{"_embedded":{"balances":[{"id":"balance_dyz5APsJebDef9oTW9J2Hc","created_at":"2024-11-14T22:25:48.01Z","updated_at":"2024-11-14T22:25:48.01Z","available_amount":4236592,"currency":"USD","linked_to":null,"linked_type":"APPLICATION","pending_amount":4236592,"posted_amount":4236592,"tags":{"created_via":"SYSTEM","description":"BrainTree"},"type":"DISBURSEMENT","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances?limit=3"}},"page":{"limit":3,"next_cursor":"balance_dyz5APsJebDef9oTW9J2Hc"}},"key":"List of Balances","summary":"List of Balances","id":"paths/~1balances~1{balance_id}~1balance_entries/get/responses/200/content/application~1json/examples/List of Balances"},"paths/~1balances~1{balance_id}~1balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc/balance_entries"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1balances~1{balance_id}~1balance_entries/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1balances~1{balance_id}~1balance_entries/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc/balance_entries"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1balances~1{balance_id}~1balance_entries/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1balances~1{balance_id}~1balance_entries/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc/balance_entries"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1balances~1{balance_id}~1balance_entries/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1balances~1{balance_id}~1balance_entries/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balances/balance_dyz5APsJebDef9oTW9J2Hc/balance_entries"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1balances~1{balance_id}~1balance_entries/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1balance_entries~1{balance_entry_id}/get/responses/200/content/application~1json/examples/Balance Entry":{"value":{"id":"balance_entry_2yqLu8vYUroqDByd3bQVvE","created_at":"2025-11-07T22:49:42.16Z","updated_at":"2025-11-09T00:00:03.48Z","amount":15000,"created_by":"SYSTEM","currency":"USD","description":null,"entity_id":"TR2vw93rwm6LkH1MES6T9uYe","entity_type":"TRANSFER","estimated_posted_date":"2025-11-09T00:00:04.666Z","linked_to":"APc9vhYcPsRuTSpKD9KpMtPe","linked_type":"APPLICATION","parent_balance_entry_id":null,"posted_at":"2025-11-09T00:00:04.666Z","state":"SUCCEEDED","tags":{},"transaction_date":null,"type":"PUSH_TO_CARD","wire_details":{"external_reference_number":null},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_entries/balance_entry_2yqLu8vYUroqDByd3bQVvE"}}},"key":"Balance Entry","summary":"Balance Entry","id":"paths/~1balance_entries~1{balance_entry_id}/get/responses/200/content/application~1json/examples/Balance Entry"},"paths/~1balance_entries~1{balance_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_entries/balance_entry_2yqLu8vYUroqDByd3bQVvE"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1balance_entries~1{balance_entry_id}/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1balance_entries~1{balance_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_entries/balance_entry_2yqLu8vYUroqDByd3bQVvE"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1balance_entries~1{balance_entry_id}/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1balance_entries~1{balance_entry_id}/get/responses/404/content/application~1json/examples/Not found":{"value":{"total":1,"_embedded":{"errors":[{"code":"NOT_FOUND","logref":"74a95fe0172485475cfc99b79336a1e6","message":"balance_entry_2yqLu8vYUroqDByd3bQVvE was not found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_entries/balance_entry_2yqLu8vYUroqDByd3bQVvE"}}}]}},"key":"Not found","summary":"Not found","id":"paths/~1balance_entries~1{balance_entry_id}/get/responses/404/content/application~1json/examples/Not found"},"paths/~1balance_entries~1{balance_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_entries/balance_entry_2yqLu8vYUroqDByd3bQVvE"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1balance_entries~1{balance_entry_id}/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1balance_adjustments/post/requestBody/content/application~1json/examples/Balance Adjustment":{"value":{"amount":10000,"currency":"USD","description":"Sample balance adjustment","instrument_id":"PI4Ppf8rxWYapuEqQr3u6efi","processor":"DUMMY_V1","rail":"ACH","tags":{"order_id":"ORD-123"},"type":"TOP_UP"},"key":"Balance Adjustment","summary":"Balance Adjustment","id":"paths/~1balance_adjustments/post/requestBody/content/application~1json/examples/Balance Adjustment"},"paths/~1balance_adjustments/post/responses/201/content/application~1json/examples/Balance Adjustment":{"value":{"id":"balance_adjustment_dFsjPzNKtp7RjqAPtKtr27","created_at":"2026-09-25T20:05:05.821889Z","updated_at":"2026-09-25T20:05:06.165101Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","balance_entry_id":"balance_entry_dGJGMPjmWJ7VU7G7TfPXfE","currency":"USD","description":"Sample balance adjustment","failure_code":null,"failure_message":null,"idempotency_id":null,"instrument_id":"PI4Ppf8rxWYapuEqQr3u6efi","rail":"ACH","state":"SUCCEEDED","tags":{"order_id":"ORD-123"},"top_up_config_id":null,"trace_id":"c3203e36-c750-4230-8120-dad179acd4e0","type":"TOP_UP","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments/balance_adjustment_dFsjPzNKtp7RjqAPtKtr27"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},"key":"Balance Adjustment","summary":"Balance Adjustment","id":"paths/~1balance_adjustments/post/responses/201/content/application~1json/examples/Balance Adjustment"},"paths/~1balance_adjustments/post/responses/400/content/application~1json/examples/Malformed request":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"ff8d4c15227ac8201c24f31baf4281f","message":"Malformed request.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Malformed request","summary":"Malformed request","id":"paths/~1balance_adjustments/post/responses/400/content/application~1json/examples/Malformed request"},"paths/~1balance_adjustments/post/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1balance_adjustments/post/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Owner identity is invalid":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Owner identity is invalid; could not find business data","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Owner identity is invalid","summary":"Owner identity is invalid","id":"paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Owner identity is invalid"},"paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Could not retrieve owner identity data":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Could not retrieve owner identity data","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Could not retrieve owner identity data","summary":"Could not retrieve owner identity data","id":"paths/~1balance_adjustments/post/responses/403/content/application~1json/examples/Could not retrieve owner identity data"},"paths/~1balance_adjustments/post/responses/404/content/application~1json/examples/Instrument not found":{"key":"Instrument not found","summary":"Instrument not found","id":"paths/~1balance_adjustments/post/responses/404/content/application~1json/examples/Instrument not found"},"paths/~1balance_adjustments/post/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1balance_adjustments/post/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Duplicate idempotency_id":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"904785c5b28c3fd2","message":"Duplicate balance_adjustment balance_adjustment_6Q2gGd5kFeeZXJvGffTLG4 already exists with idempotency_id d2a227b9-ab8f-4a50-a307-7915b63a1a5d.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"},"balance_adjustment":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments/balance_adjustment_6Q2gGd5kFeeZXJvGffTLG4"}}}]}},"key":"Duplicate idempotency_id","summary":"Duplicate idempotency_id","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Duplicate idempotency_id"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/idempotency_id too long":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"904785c5b28c3fd2","message":"idempotency_id must be between 1 and 255 characters.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"idempotency_id too long","summary":"idempotency_id too long","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/idempotency_id too long"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument ID cannot be decoded":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"provided instrument ID is invalid","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Instrument ID cannot be decoded","summary":"Instrument ID cannot be decoded","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument ID cannot be decoded"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not bank account":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Invalid instrument type, only BANK_ACCOUNT instrument can perform balance adjustment","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Instrument is not bank account","summary":"Instrument is not bank account","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not bank account"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not enabled":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Payment could not be submitted since Payment Instrument is marked as disabled. Please use a Payment Instrument that's enabled and try again.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Instrument is not enabled","summary":"Instrument is not enabled","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument is not enabled"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Routing number invalid":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_BANK_ACCOUNT_VALIDATION_CHECK","logref":"71cdffd44d074611","message":"The provided bank account cannot be used because the routing number is no longer valid. Please check that the account holder's routing number and account are correct or attempt with another bank account.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Routing number invalid","summary":"Routing number invalid","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Routing number invalid"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Disbursement not enabled for application":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Disbursements not enabled for this application","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Disbursement not enabled for application","summary":"Disbursement not enabled for application","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Disbursement not enabled for application"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in platform":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"provided instrument is not valid or found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Instrument not in platform","summary":"Instrument not in platform","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in platform"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in application":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"provided instrument is not valid or found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Instrument not in application","summary":"Instrument not in application","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument not in application"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument identity is not application owner":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Instrument identity is not application owner","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Instrument identity is not application owner","summary":"Instrument identity is not application owner","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Instrument identity is not application owner"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Invalid processor":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"processor is not valid or found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Invalid processor","summary":"Invalid processor","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Invalid processor"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't find owner identity":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Application owner identity is not valid or found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Couldn't find owner identity","summary":"Couldn't find owner identity","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't find owner identity"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't parse processor type provided":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Invalid processor provided","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Couldn't parse processor type provided","summary":"Couldn't parse processor type provided","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Couldn't parse processor type provided"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve facilitating merchant":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Facilitating merchant is not valid or found","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Could not retrieve facilitating merchant","summary":"Could not retrieve facilitating merchant","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve facilitating merchant"},"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve owner identity business data":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"71cdffd44d074611","message":"Couldn't retrieve owner identity business data","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Could not retrieve owner identity business data","summary":"Could not retrieve owner identity business data","id":"paths/~1balance_adjustments/post/responses/422/content/application~1json/examples/Could not retrieve owner identity business data"},"paths/~1balance_adjustments/get/responses/200/content/application~1json/examples/List of Balance Adjustments":{"value":{"_embedded":{"balance_adjustments":[{"id":"balance_adjustment_dFsjPzNKtp7RjqAPtKtr27","created_at":"2026-09-25T20:05:05.821889Z","updated_at":"2026-09-25T20:05:06.165101Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","balance_entry_id":"balance_entry_dGJGMPjmWJ7VU7G7TfPXfE","currency":"USD","description":"Sample balance adjustment","failure_code":null,"failure_message":null,"idempotency_id":null,"instrument_id":"PI4Ppf8rxWYapuEqQr3u6efi","rail":"ACH","state":"SUCCEEDED","tags":{"order_id":"ORD-123"},"top_up_config_id":null,"trace_id":"c3203e36-c750-4230-8120-dad179acd4e0","type":"TOP_UP","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments/balance_adjustment_dFsjPzNKtp7RjqAPtKtr27"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"balance_adjustment_wtwhv2KVw2AxrbXNeomvgk","created_at":"2026-09-25T20:01:58.087558Z","updated_at":"2026-09-25T20:01:58.457980Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","balance_entry_id":"balance_entry_wuW1pGdqj5fuugiQL6z9e9","currency":"USD","description":"Sample balance adjustment","failure_code":null,"failure_message":null,"idempotency_id":null,"instrument_id":"PI4Ppf8rxWYapuEqQr3u6efi","rail":"ACH","state":"SUCCEEDED","tags":{"order_id":"ORD-123"},"top_up_config_id":null,"trace_id":"71266c01-7986-4fc4-8585-2266773828dc","type":"TOP_UP","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments/balance_adjustment_wtwhv2KVw2AxrbXNeomvgk"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}},{"id":"balance_adjustment_sfzW7SUSNds9sRwPskN2Z5","created_at":"2026-09-25T20:01:00.710942Z","updated_at":"2026-09-25T20:01:01.034540Z","amount":10000,"application_id":"APc9vhYcPsRuTSpKD9KpMtPe","balance_entry_id":"balance_entry_sgEk65t85uy7kHdY7TxG6w","currency":"USD","description":"Sample balance adjustment","failure_code":null,"failure_message":null,"idempotency_id":null,"instrument_id":"PI4Ppf8rxWYapuEqQr3u6efi","rail":"ACH","state":"SUCCEEDED","tags":{"order_id":"ORD-123"},"top_up_config_id":null,"trace_id":"5ffe12cd-70bf-4740-896e-8a333c7a21f0","type":"TOP_UP","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments/balance_adjustment_sfzW7SUSNds9sRwPskN2Z5"},"application":{"href":"https://finix.sandbox-payments-api.com/applications/APc9vhYcPsRuTSpKD9KpMtPe"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments?limit=3"},"next":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments?limit=3&after_cursor=balance_adjustment_sfzW7SUSNds9sRwPskN2Z5"}},"page":{"limit":3,"next_cursor":"balance_adjustment_sfzW7SUSNds9sRwPskN2Z5"}},"key":"List of Balance Adjustments","summary":"List of Balance Adjustments","id":"paths/~1balance_adjustments/get/responses/200/content/application~1json/examples/List of Balance Adjustments"},"paths/~1balance_adjustments/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1balance_adjustments/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1balance_adjustments/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1balance_adjustments/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1balance_adjustments/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1balance_adjustments/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1balance_adjustments/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/balance_adjustments"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1balance_adjustments/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1disbursement_rules/get/responses/200/content/application~1json/examples/List of Disbursement Rules":{"value":{"_embedded":{"disbursement_rules":[{"id":"disbursement_rule_fxhfAsS68Vf4zjoVXDTQYL","created_at":"2024-11-14T22:26:14.88Z","updated_at":"2024-11-14T22:27:07.67Z","application_details":{"ach_rules":[{"type":"TIME_RANGE","currency":"USD","time_frame":"DAILY","start_time":11,"time_zone":"America/New_York","rules":[{"volume_limit":1000001,"count_limit":2001,"enabled":true,"day":"ALL"}]},{"type":"TIME_RANGE","currency":"USD","time_frame":"MONTHLY","start_time":11,"time_zone":"America/New_York","start_date":15,"rules":[{"volume_limit":1000002,"count_limit":2002,"enabled":true}]},{"type":"GLOBAL","currency":"USD","max_transaction_amount":5000001}],"card_rules":[{"type":"TIME_RANGE","currency":"USD","time_frame":"DAILY","start_time":11,"time_zone":"America/New_York","rules":[{"volume_limit":1000003,"count_limit":2003,"enabled":true,"day":"ALL"}]},{"type":"TIME_RANGE","currency":"USD","time_frame":"MONTHLY","start_time":11,"time_zone":"America/New_York","start_date":15,"rules":[{"volume_limit":1000004,"count_limit":2004,"enabled":true}]},{"type":"GLOBAL","currency":"USD","max_transaction_amount":5000002}],"balance_adjustment_rules":[{"type":"TIME_RANGE","currency":"USD","time_frame":"DAILY","start_time":1,"time_zone":"America/New_York","rules":[{"volume_limit":10000000,"count_limit":10000,"enabled":true,"day":"ALL"}]},{"type":"TIME_RANGE","currency":"USD","time_frame":"MONTHLY","start_time":1,"time_zone":"America/New_York","start_date":1,"rules":[{"volume_limit":10000000,"count_limit":100000,"enabled":true}]},{"type":"GLOBAL","currency":"USD","max_transaction_amount":10000000}]},"linked_to":"APc9vhYcPsRuTSpKD9KpMtPe","linked_type":"APPLICATION","recipient_details":{"ach_rules":[{"type":"TIME_RANGE","currency":"USD","time_frame":"DAILY","start_time":11,"time_zone":"America/New_York","rules":[{"volume_limit":1000005,"count_limit":2005,"enabled":true,"day":"ALL"}]},{"type":"TIME_RANGE","currency":"USD","time_frame":"MONTHLY","start_time":11,"time_zone":"America/New_York","start_date":15,"rules":[{"volume_limit":1000006,"count_limit":2006,"enabled":true}]},{"type":"GLOBAL","currency":"USD","max_transaction_amount":5000003}],"card_rules":[{"type":"TIME_RANGE","currency":"USD","time_frame":"DAILY","start_time":11,"time_zone":"America/New_York","rules":[{"volume_limit":1000007,"count_limit":2007,"enabled":true,"day":"ALL"}]},{"type":"TIME_RANGE","currency":"USD","time_frame":"MONTHLY","start_time":11,"time_zone":"America/New_York","start_date":15,"rules":[{"volume_limit":1000008,"count_limit":2008,"enabled":true}]},{"type":"GLOBAL","currency":"USD","max_transaction_amount":5000004}]},"sender_details":{"ach_rules":[{"type":"TIME_RANGE","currency":"USD","time_frame":"DAILY","start_time":11,"time_zone":"America/New_York","rules":[{"volume_limit":1000009,"count_limit":2009,"enabled":true,"day":"ALL"}]},{"type":"TIME_RANGE","currency":"USD","time_frame":"MONTHLY","start_time":11,"time_zone":"America/New_York","start_date":15,"rules":[{"volume_limit":1000010,"count_limit":2010,"enabled":true}]},{"type":"GLOBAL","currency":"USD","max_transaction_amount":5000005}],"card_rules":[{"type":"TIME_RANGE","currency":"USD","time_frame":"DAILY","start_time":11,"time_zone":"America/New_York","rules":[{"volume_limit":1000011,"count_limit":2011,"enabled":true,"day":"ALL"}]},{"type":"TIME_RANGE","currency":"USD","time_frame":"MONTHLY","start_time":11,"time_zone":"America/New_York","start_date":15,"rules":[{"volume_limit":1000012,"count_limit":2012,"enabled":true}]},{"type":"GLOBAL","currency":"USD","max_transaction_amount":5000006}]},"tags":{},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules/disbursement_rule_fxhfAsS68Vf4zjoVXDTQYL"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules?limit=3&linked_to=APc9vhYcPsRuTSpKD9KpMtPe"}},"page":{"limit":3,"next_cursor":"disbursement_rule_fxhfAsS68Vf4zjoVXDTQYL"}},"key":"List of Disbursement Rules","summary":"List of Disbursement Rules","id":"paths/~1disbursement_rules/get/responses/200/content/application~1json/examples/List of Disbursement Rules"},"paths/~1disbursement_rules/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disbursement_rules/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disbursement_rules/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disbursement_rules/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disbursement_rules/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disbursement_rules/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disbursement_rules/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1disbursement_rules/get/responses/422/content/application~1json/examples/Invalid query param value"},"paths/~1disbursement_rules~1current_usages/get/responses/200/content/application~1json/examples/List of Disbursement Rules":{"value":{"_embedded":{"current_usages":[{"linked_to":"APc9vhYcPsRuTSpKD9KpMtPe","linked_type":"APPLICATION","type":"TOTAL","currency":"USD","ach_velocity":{"daily_velocity":{"current_volume":0,"current_count":0,"volume_limit":1000001,"count_limit":2001,"window_reset":"2026-09-26T15:00:00Z"},"monthly_velocity":{"current_volume":0,"current_count":0,"volume_limit":1000002,"count_limit":2002,"window_reset":"2026-10-15T15:00:00Z"}},"card_velocity":{"daily_velocity":{"current_volume":0,"current_count":0,"volume_limit":1000003,"count_limit":2003,"window_reset":"2026-09-26T15:00:00Z"},"monthly_velocity":{"current_volume":990000,"current_count":66,"volume_limit":1000004,"count_limit":2004,"window_reset":"2026-10-15T15:00:00Z"}},"balance_adjustment_velocity":{"daily_velocity":{"current_volume":50000,"current_count":5,"volume_limit":10000000,"count_limit":10000,"window_reset":"2026-09-26T05:00:00Z"},"monthly_velocity":{"current_volume":2921140,"current_count":352,"volume_limit":10000000,"count_limit":100000,"window_reset":"2026-10-01T05:00:00Z"}},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules/current_usages"}}}]},"_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules/current_usages?limit=3&linked_to=APc9vhYcPsRuTSpKD9KpMtPe"}},"page":{"limit":3,"next_cursor":null}},"key":"List of Disbursement Rules","summary":"List of Disbursement Rules","id":"paths/~1disbursement_rules~1current_usages/get/responses/200/content/application~1json/examples/List of Disbursement Rules"},"paths/~1disbursement_rules~1current_usages/get/responses/400/content/application~1json/examples/Missing query param":{"value":{"total":1,"_embedded":{"errors":[{"code":"BAD_REQUEST","logref":"b1453d26efe6efb8","message":"Required request parameter 'linked_to' for method parameter type String is not present.","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/current_usages"}}}]}},"key":"Missing query param","summary":"Missing query param","id":"paths/~1disbursement_rules~1current_usages/get/responses/400/content/application~1json/examples/Missing query param"},"paths/~1disbursement_rules~1current_usages/get/responses/401/content/application~1json/examples/Unauthorized request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"3c46a12e64b39c02","message":"Unauthorized","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules/current_usages"}}}]}},"key":"Unauthorized request","summary":"Unauthorized request","id":"paths/~1disbursement_rules~1current_usages/get/responses/401/content/application~1json/examples/Unauthorized request"},"paths/~1disbursement_rules~1current_usages/get/responses/403/content/application~1json/examples/Forbidden request":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNKNOWN","logref":"48f927fb34aebfc152a3e6610fc11b98","message":"Access is denied","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules/current_usages"}}}]}},"key":"Forbidden request","summary":"Forbidden request","id":"paths/~1disbursement_rules~1current_usages/get/responses/403/content/application~1json/examples/Forbidden request"},"paths/~1disbursement_rules~1current_usages/get/responses/406/content/application~1json/examples/Not acceptable":{"value":{"total":1,"_embedded":{"errors":[{"code":"UNPROCESSABLE_ENTITY","logref":"3bf7412c5cadda3efeb166e3702fca41","message":"Could not find acceptable representation","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules/current_usages"}}}]}},"key":"Not acceptable","summary":"Not acceptable","id":"paths/~1disbursement_rules~1current_usages/get/responses/406/content/application~1json/examples/Not acceptable"},"paths/~1disbursement_rules~1current_usages/get/responses/422/content/application~1json/examples/Invalid query param value":{"value":{"total":1,"_embedded":{"errors":[{"code":"INVALID_FIELD","logref":"90e72a8346f950ff2a46e899f28b5104","message":"limit param must be between 0 and 100","_links":{"self":{"href":"https://finix.sandbox-payments-api.com/disbursement_rules/current_usages"}}}]}},"key":"Invalid query param value","summary":"Invalid value for query param","id":"paths/~1disbursement_rules~1current_usages/get/responses/422/content/application~1json/examples/Invalid query param value"}},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"}},"servers":[{"url":"https://finix.sandbox-payments-api.com","description":"Sandbox server"}],"specType":"openapi"},"options":{"codeSamples":{"languages":[{"lang":"curl","label":"cURL"}]},"hideDownloadButtons":true,"hideReplay":true,"hideSchemaTitles":true,"mockServer":{"url":"/_mock/api","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api/index.json?download"},{"url":"/_bundle/api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Finix API Reference","description":"---\nseo:\n  title: Finix API Reference\n  description: API Reference Documentation for the Finix API. Includes sample API requests and responses.\n---\n\nThe Finix API is resource oriented, relying heavily on common REST principles. Our API uses JSON encoded requests and responses.\n\nYou will receive separate Sandbox and Live accounts, as well as corresponding API credentials to access the Finix API.\n\n---\n\n## Authentication\n\nTo communicate with the Finix API, you must authenticate your requests via HTTP Basic Authentication with a `username:password` combination, which you can get from your Finix Dashboard. If you do not have a Dashboard yet, you can test our APIs with the Sandbox credentials below.\n\n{% table %}\n\n- Parameter\n- Value\n\n---\n\n- Sandbox Username\n- `USsRhsHYZGBPnQw8CByJyEQW`\n\n---\n\n- Sandbox Password\n- `8a14c2f9-d94b-4c72-8f5c-a62908e5b30e`\n\n{% /table %}\n\n```shell {% title=\"Request Format\" %}\ncurl \"https://finix.sandbox-payments-api.com/\" \\\n    -H \"Content-Type: application/json\" \\\n    -H \"Finix-Version: 2022-02-01\" \\\n    -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n```\n\n---\n\n## Environments\n\nFinix provides two environments with distinct base URLs to make API requests.\n\n1. A Sandbox environment for developing and testing your integration.\n2. A Live environment for processing payments.\n\nThese environments are entirely separate and do not share API Credentials.\n\n{% table %}\n\n- Environment\n- Endpoint URL\n\n---\n\n- Sandbox\n- `https://finix.sandbox-payments-api.com`\n\n---\n\n- Live\n- `https://finix.live-payments-api.com`\n\n{% /table %}\n\n{% admonition type=\"info\" name=\"Live Access\" %}\nTo get access to the Live environment, please reach out to your Finix point-of-contact.\n{% /admonition %}\n\n---\n\n## HTTP Codes and Errors\n\nFinix uses HTTP codes to communicate whether requests succeeded or failed. Requests to Finix's API return responses within less than one second.\n\nHowever, communications between card networks and processors can increase response latency. Response latency for card-present devices can also be higher depending on how quickly buyers complete the transaction on payment terminals.\n\nDue of this, requests to the Finix API have a maximum timeout of 5 minutes.\n\nFor more details, see [Error Codes](/additional-resources/developers/implementation-and-testing/error-codes/). Also, you can [test for specific errors and responses](/additional-resources/developers/implementation-and-testing/testing-your-integration/).\n\n{% table %}\n\n- Code {% width=\"10%\" %}\n- Definition {% width=\"35%\" %}\n- Explanation {% width=\"55%\" %}\n\n---\n\n- `400`\n- Bad Request\n- We could not parse your request. Verify you are providing valid JSON.\n\n---\n\n- `401`\n- Unauthorized\n- We could not authenticate your request. Verify your `username` and `password` are correct.\n\n---\n\n- `402`\n- Upstream Processor Error\n- Errors caused by 3rd-party service(s).\n\n---\n\n- `403`\n- Forbidden\n- Your credentials do not have the correct permissions to perform the request.\n\n---\n\n- `404`\n- Not Found\n- We could not find the specified resource.\n\n---\n\n- `405`\n- Method Not Allowed\n- The specified resource does not support the HTTP Method used to submit the request.\n\n---\n\n- `406`\n- Not Acceptable\n- The server could accept the submitted request. Confirm how the request was formatted and submitted.\n\n---\n\n- `409`\n- Conflict\n- The submitted request conflicts with the current state of the server.\n\n---\n\n- `422`\n- Unprocessable Entity\n- The parameters were valid, but the request failed. Usually, the error involves misunderstanding of how to perform the request (e.g., creating a transfer with a seller that is not-yet-approved).\n\n---\n\n- `500`\n- Internal Server Error\n- We had a problem with our server. Try again later.\n\n{% /table %}\n\n---\n\n## Idempotent Requests\n\nThe `Authorization` and `Transfer` resources both have an `idempotency_id` field. Use this field to ensure the API Request is performed **_only once_**.\n\nWhy is this important? We've all experienced a checkout page that hangs on a request or payment, and feared that if we refresh or submit the payment again, we'd be charged twice.\n\nFinix removes this ambiguity with the `idempotency_id`. You or the user can generate a unique ID that can be included as an `idempotency_id` with the usual request payload. If anyone attempts a request with the same `idempotency_id`, the response will raise an exception.\n\nBy passing an `idempotency_id` in the body of your requests, you can be rest assured that when you create an `Authorization` or `Transfer`, the user will be protected from potential network issues.\n\n`idempotency_id` is available on the following three endpoints:\n\n- `/transfers`\n- `/authorizations`\n- `/transfers/{id}/reversals`\n\n{% admonition type=\"warning\" name=\"`idempotency_id` scope\" %}\n`idempotency_id` checks against previous requests made on the same endpoint.\n{% /admonition %}\n\n---\n\n## Query Parameters\n\nEvery Finix resource (e.g., `Authorizations`, `Transfers`) can be listed and reviewed using `GET` requests. Every endpoint also has query parameters available to help you filter the resources that are returned.\n\nSee the following example of how to query the `Transfers` endpoint for `Transfer` resources with `type: DEBIT`.\n\n```shell {% title=\"Query Parameter Example\" %}\ncurl \"https://finix.sandbox-payments-api.com/transfers?type=DEBIT\" \\\n    -H \"Finix-Version: 2022-02-01\" \\\n    -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e\n```\n\n---\n\n## Tags\n\nMany Finix resources (e.g., `Authorization`, `Transfer`) let you include `tags` to add key-value metadata to your Finix API resources. For example, when creating a Transfer, you might include `customerId: Customer123` to tag the Transfer with your internal customer ID. You can update tags as many times as needed, as well as filter resources by tags.\n\n```json {% title=\"Tags Example\" %}\n{\n    ...,\n    \"tags\": {\n        \"card-type\": \"business card\",\n        \"order_number\": \"H-1257\",\n        \"customer_order_reference\": \"order1234\",\n        \"item_type\": \"hardware\",\n        \"vendor\": \"finix\"\n    }\n}\n```\n\nThe `tags` object accepts up to 50 `key: value` pairs to annotate resources with custom metadata.\n\n- Maximum character length for individual `keys` is 40.\n- Maximum character length for individual `values` is 500.\n\n{% admonition type=\"warning\" name=\"Special Characters\" %}\nFinix does **_not_** allow special characters on tags (e.g., `\\`, `,`, `\"`, `'`)\n{% /admonition %}\n\n---\n\n## Versioning\n\nAs Finix improves our products and features, we will make changes to our APIs. When breaking changes are made to Finix's API, we may release a new dated API version.\n\nThe API version your requests use controls how API responses and webhooks behave (for example, the values you see in responses and the parameters you can include in requests). For more information, see [Versioning](/additional-resources/developers/authentication-and-api-basics/versioning/).\n\n<br/>\n\n---\n\n## Postman Collection\n\nFinix has a Postman collection to help in your development. You can fork it using the button below.\n\n[<img id=\"postman-btn\" src=\"https://run.pstmn.io/button.svg\" alt=\"Run In Postman\" style=\"width: 128px; height: 32px;\">](https://god.gw.postman.com/run-collection/47694266-26c1778a-64ad-473d-ba6f-440777f2c9c8?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D47694266-26c1778a-64ad-473d-ba6f-440777f2c9c8%26entityType%3Dcollection%26workspaceId%3D72d1f1c9-5637-4a7f-be9b-25fc89a3a2ff)\n"}},"baseSlug":"/api","routesMapping":{}}