{"items":[{"type":"link","label":"Computop Paygate API","link":"/","routeSlug":"/"},{"type":"group","label":"Guide","link":"/guide","routeSlug":"/guide","items":[]},{"type":"group","label":"Authentication","link":"/authentication","routeSlug":"/authentication","items":[{"label":"Request OAuth Token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/authentication/authorizationservice","routeSlug":"/authentication/authorizationservice","metadata":{"seo":{"title":"Request OAuth Token","description":"This endpoint is to generate a short-lived JSON Web token (JWT)"}},"httpPath":"/authorization/oauth/token"}]},{"type":"group","label":"Payments","link":"/payments","routeSlug":"/payments","items":[{"label":"Create checkout session","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/createsession","routeSlug":"/payments/createsession","metadata":{"seo":{"title":"Create checkout session","description":"This endpoint generates a URL for a hosted payment page where customers can securely select their preferred payment method and complete their transaction."}},"httpPath":"/payments/sessions"},{"label":"Create payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/createpayment","routeSlug":"/payments/createpayment","metadata":{"seo":{"title":"Create payment","description":"This endpoint is used to initiate a payment for a specific payment method. You can choose between two integration types: HOSTED: Returns a URL for a payment method-specific hosted form, where the customer is redirected to securely complete the payment. DIRECT: Enables server-to-server communication, where you manage the payment UI and directly interacts with the API to process payments. Note 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."}},"httpPath":"/payments"},{"label":"Confirm payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/confirmpayment","routeSlug":"/payments/confirmpayment","metadata":{"seo":{"title":"Confirm payment","description":"This 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."}},"httpPath":"/payments/{id}/confirms"},{"label":"Incremental authorization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/incrementauthorization","routeSlug":"/payments/incrementauthorization","metadata":{"seo":{"title":"Incremental authorization","description":"This 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."}},"httpPath":"/payments/{id}/incrementals"},{"label":"Reverse payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/reversepayment","routeSlug":"/payments/reversepayment","metadata":{"seo":{"title":"Reverse payment","description":"This endpoint is used to reverse a payment that has not yet been captured, effectively canceling the authorization."}},"httpPath":"/payments/{id}/reversals"},{"label":"Capture payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/capturepayment","routeSlug":"/payments/capturepayment","metadata":{"seo":{"title":"Capture payment","description":"This endpoint is used to capture an existing authorized payment."}},"httpPath":"/payments/{id}/captures"},{"label":"Refund payment with reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/refundpayment","routeSlug":"/payments/refundpayment","metadata":{"seo":{"title":"Refund payment with reference","description":"This endpoint is used to refund a captured payment."}},"httpPath":"/payments/{id}/refunds"},{"label":"Refund payment without reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/refundexternalpayment","routeSlug":"/payments/refundexternalpayment","metadata":{"seo":{"title":"Refund payment without reference","description":"This endpoint is used to refund a payment without reference."}},"httpPath":"/payments/refunds"},{"label":"Retrieve payment details by Transaction ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/getpaymentdetailsbytransactionid","routeSlug":"/payments/getpaymentdetailsbytransactionid","metadata":{"seo":{"title":"Retrieve payment details by Transaction ID","description":"This endpoint is used to retrieve payment details with the Transaction ID (transId)."}},"httpPath":"/payments/getByTransId/{id}"},{"label":"Retrieve payment details by Payment ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/getpaymentdetailsbypaymentid","routeSlug":"/payments/getpaymentdetailsbypaymentid","metadata":{"seo":{"title":"Retrieve payment details by Payment ID","description":"Returns all details about existing payment."}},"httpPath":"/payments/getByPayId/{id}"},{"label":"Update payment details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/updatepaymentdetails","routeSlug":"/payments/updatepaymentdetails","metadata":{"seo":{"title":"Update payment details","description":"Update details about existing payment."}},"httpPath":"/payments/{id}"},{"label":"Create payment link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/payments/createpaymentlink","routeSlug":"/payments/createpaymentlink","metadata":{"seo":{"title":"Create payment link","description":"This 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."}},"httpPath":"/payments/links"}]},{"type":"group","label":"Webhooks","link":"/webhooks","routeSlug":"/webhooks","items":[{"label":"Enhanced Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/paths/~1{merchantenhancedwebhookurl}/post","routeSlug":"/webhooks/paths/~1{merchantenhancedwebhookurl}/post","metadata":{"seo":{"title":"Enhanced Webhook","description":"The Enhanced Webhook includes detailed transaction data in the payload and is signed with an HMAC signature to ensure authenticity and integrity."}},"httpPath":"/{merchantEnhancedWebhookUrl}"},{"label":"Basic Webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/paths/~1{merchantbasicwebhookurl}/post","routeSlug":"/webhooks/paths/~1{merchantbasicwebhookurl}/post","metadata":{"seo":{"title":"Basic Webhook","description":"The payload contains only the unique Computop Paygate payId. The merchant can use this value to call the Retrieve payment details by payment ID endpoint to obtain full transaction details. Since no sensitive data is transmitted, no HMAC signature is used for this Webhook type. When the merchant receives a webhook, their endpoint must respond with an HTTP status code to acknowledge successful processing."}},"httpPath":"/{merchantBasicWebhookUrl}"}]},{"type":"group","label":"PaymentPlans","link":"/paymentplans","routeSlug":"/paymentplans","items":[{"label":"Create payment within payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/paymentplans/chargepaymentplan","routeSlug":"/paymentplans/chargepaymentplan","metadata":{"seo":{"title":"Create payment within payment plan","description":"Create payment within payment plan"}},"httpPath":"/payment-plans/{paymentPlanId}/charge"},{"label":"Cancel payment plan","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/paymentplans/cancelpaymentplan","routeSlug":"/paymentplans/cancelpaymentplan","metadata":{"seo":{"title":"Cancel payment plan","description":"Cancel payment plan"}},"httpPath":"/payment-plans/{paymentPlanId}/cancel"},{"label":"Get list of payment plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/paymentplans/getpaymentplans","routeSlug":"/paymentplans/getpaymentplans","metadata":{"seo":{"title":"Get list of payment plans","description":"Get list of payment plans"}},"httpPath":"/payment-plans"},{"label":"Get payment plan by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/paymentplans/getpaymentplanbyid","routeSlug":"/paymentplans/getpaymentplanbyid","metadata":{"seo":{"title":"Get payment plan by id","description":"Get payment plan by id"}},"httpPath":"/payment-plans/{paymentPlanId}"},{"label":"List payments within a payment plan","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/paymentplans/listpaymentswithinpaymentplan","routeSlug":"/paymentplans/listpaymentswithinpaymentplan","metadata":{"seo":{"title":"List payments within a payment plan","description":"Returns a paginated list of payments that belong to the given payment plan."}},"httpPath":"/payment-plans/{paymentPlanId}/payments"}]},{"type":"group","label":"Mobile SDK","link":"/mobile-sdk","routeSlug":"/mobile-sdk","items":[{"label":"Create payment intent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/mobile-sdk/createpaymentintent","routeSlug":"/mobile-sdk/createpaymentintent","metadata":{"seo":{"title":"Create payment intent","description":"This endpoint is used to create a payment intent"}},"httpPath":"/payment-intents"}]},{"type":"group","label":"Customers","link":"/customers","routeSlug":"/customers","items":[{"label":"Get list of customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/getcustomers","routeSlug":"/customers/getcustomers","metadata":{"seo":{"title":"Get list of customers","description":"Get list of customers"}},"httpPath":"/customers"},{"label":"Get customer details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/getcustomer","routeSlug":"/customers/getcustomer","metadata":{"seo":{"title":"Get customer details","description":"Get customer details"}},"httpPath":"/customers/{id}"},{"label":"Update customer details","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/updatecustomer","routeSlug":"/customers/updatecustomer","metadata":{"seo":{"title":"Update customer details","description":"Updates details about customer"}},"httpPath":"/customers/{id}"},{"label":"Delete customer details","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/deletecustomer","routeSlug":"/customers/deletecustomer","metadata":{"seo":{"title":"Delete customer details","description":"Delete customer details"}},"httpPath":"/customers/{id}"},{"label":"Get list of payment methods for customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/getpaymentmethods","routeSlug":"/customers/getpaymentmethods","metadata":{"seo":{"title":"Get list of payment methods for customer","description":"Get list of payment methods for customer"}},"httpPath":"/customers/{id}/paymentMethods"},{"label":"Get payment method details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/getpaymentmethod","routeSlug":"/customers/getpaymentmethod","metadata":{"seo":{"title":"Get payment method details","description":"Get payment method details"}},"httpPath":"/customers/{customerId}/paymentMethods/{paymentMethodId}"},{"label":"Delete payment method details","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/deletepaymentmethod","routeSlug":"/customers/deletepaymentmethod","metadata":{"seo":{"title":"Delete payment method details","description":"Delete payment method details"}},"httpPath":"/customers/{customerId}/paymentMethods/{paymentMethodId}"},{"label":"Get list of payment plans for customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/customers/getcustomerpaymentplans","routeSlug":"/customers/getcustomerpaymentplans","metadata":{"seo":{"title":"Get list of payment plans for customer","description":"Get list of payment plans for customer"}},"httpPath":"/customers/{customerId}/payment-plans"}]},{"type":"group","label":"CloudPos","link":"/cloudpos","routeSlug":"/cloudpos","items":[{"label":"CloudPos","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cloudpos/cloudposcommand","routeSlug":"/cloudpos/cloudposcommand","metadata":{"seo":{"title":"CloudPos","description":"Sending commands to the POS terminal."}},"httpPath":"/cloudpos"}]},{"type":"group","label":"Services","link":"/services","routeSlug":"/services","items":[{"label":"Get card country and DCC eligibility information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/binlookup","routeSlug":"/services/binlookup","metadata":{"seo":{"title":"Get card country and DCC eligibility information","description":"This endpoint is used to retrieve card country and DCC eligibility information based on the card BIN."}},"httpPath":"/services/dcc/bin-check"},{"label":"Get Dynamic Currency Conversion quote","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/dccquote","routeSlug":"/services/dccquote","metadata":{"seo":{"title":"Get Dynamic Currency Conversion quote","description":"This endpoint is used to retrieve a Dynamic Currency Conversion (DCC) quote for a given transaction amount and card BIN."}},"httpPath":"/services/dcc/quote"},{"label":"Duplication Check","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/duplicationcheck","routeSlug":"/services/duplicationcheck","metadata":{"seo":{"title":"Duplication Check","description":"This endpoint is used to detect duplicate submissions before initiating a new payment, preventing customers from being charged more than once for the same transaction."}},"httpPath":"/services/duplicationCheck"},{"label":"Account Updater","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/accountupdater","routeSlug":"/services/accountupdater","metadata":{"seo":{"title":"Account Updater","description":"This endpoint is used to check updates and sends updated credit card data back in response."}},"httpPath":"/services/accountUpdater"},{"label":"Get Token Service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/services/createpseudonumber","routeSlug":"/services/createpseudonumber","metadata":{"seo":{"title":"Get Token Service","description":"Get Token Service"}},"httpPath":"/services/createPseudoNumber"}]},{"type":"group","label":"Change log","link":"/change-log","routeSlug":"/change-log","items":[]}]}