{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-index.yaml","sidebar":"sidebar-sidebars.yaml"},"props":{"definitionId":"index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/","seo":{"title":"Payments","description":"\n**Create checkout session**\n\nThis endpoint generates a URL for a hosted payment page where customers can securely select their preferred payment method and complete their transaction.\n\n**Create payment**\n\nThis endpoint is used to initiate a payment for a specific payment method. You can choose between two integration types:\n  * HOSTED: Returns a URL for a payment method-specific hosted form, where the customer is redirected to securely complete the payment.\n  * DIRECT: Enables server-to-server communication, where you manage the payment UI and directly interacts with the API to process payments.\n\n\nNote that not all payment methods support both HOSTED and DIRECT integration types. Some support only one of these options, while others support both. For detailed information about the supported integration types for each payment method, refer to the payment method-specific documentation in our product guide.\n\n**Confirm payment**\n\nThis endpoint is used for payment methods that require a multi-step payment flow. It allows you to confirm a previously created payment instance (initiated via the Create Payment endpoint) to complete the transaction. This step is essential for certain payment methods to finalize the payment process.\n\n**Incremental authorization**\n\nThis endpoint allows you to increase the authorized amount for an existing card transaction when the initial authorization is insufficient. The additional amount is appended to the original authorization, and the total authorized amount reflects both.\n\n**Reverse payment**\n\nThis endpoint is used to reverse a payment that has not yet been captured, effectively canceling the authorization.\n\n**Capture payment**\n\nThis endpoint is used to capture an existing authorized payment.\n\n**Refund payment**\n\nThis endpoint is used to refund a captured payment.\n\n**Refund payment without reference**\n\nThis endpoint is used to refund a payment without reference.\n\n**Retrieve payment details by Payment ID**\n\nThis endpoint is used to retrieve payment details with the Payment ID (payId)\n\n**Retrieve payment details by Transaction ID**\n\nThis endpoint is used to retrieve payment details with the Transaction ID (transId)\n\n**Update payment details**\n\nThis endpoint is used to update payment details\n\n**Create payment link**\n\nThis endpoint allows you to generate a payment link that can be shared with customers via email, SMS, or other channels. When customers click the link, they are redirected to a hosted payment page where they can select their preferred payment method and complete the transaction.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"payments","disableAutoScroll":true,"metadata":{"subType":"openapi-operation"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"paygate-nexigroup.redocly.app","port":4000,"ipAddress":"216.73.216.78"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/payments","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}