Skip to content

Computop Paygate API (2.2.0)

The Computop Paygate API allows you to seamlessly process and manage payments, supporting 350+ payment methods worldwide. Built on REST principles, the API is designed to be predictable and developer-friendly, with resource-oriented URLs, JSON-encoded requests and responses, and standard HTTP status codes.

Security

The Computop Paygate API is designed with maximum security while remaining easy to implement. All communication occurs over HTTPS (TLS 1.2 or higher), ensuring end-to-end encryption at the transport level. This prevents packet sniffing, replay attacks, and other vulnerabilities without requiring additional encryption of the data itself.

Test Before You Go Live

Use our test environment to test your integration without affecting live data. The root URL determines whether the request is for test or live integration.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Test server
https://test.computop-paygate.com/api/v2
Production server
https://www.computop-paygate.com/api/v2

Guide

For functional documentation, please refer to the Confluence Guide

Authentication

Securely authenticate API requests using Basic Auth or OAuth 2.0

The Computop Paygate API supports two authentication methods to ensure secure access to payment processing and management endpoints. Choose the approach that aligns with your integration needs:

Basic Authentication

Use your Merchant ID as the username and API Key as the password. Combine them in the format MerchantID:APIKey, encode the string using Base64, and include it in the Authorization header with the Basic prefix for direct access to endpoints.

OAuth 2.0

Generate a short-lived JSON Web token (JWT) by authenticating with your API key via the authorization/oauth/token endpoint.

Operations

Payments

Create checkout session

This endpoint generates a URL for a hosted payment page where customers can securely select their preferred payment method and complete their transaction.

Create payment

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.

Confirm payment

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.

Incremental authorization

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.

Reverse payment

This endpoint is used to reverse a payment that has not yet been captured, effectively canceling the authorization.

Capture payment

This endpoint is used to capture an existing authorized payment.

Refund payment

This endpoint is used to refund a captured payment.

Refund payment without reference

This endpoint is used to refund a payment without reference.

Retrieve payment details by Payment ID

This endpoint is used to retrieve payment details with the Payment ID (payId)

Retrieve payment details by Transaction ID

This endpoint is used to retrieve payment details with the Transaction ID (transId)

Update payment details

This endpoint is used to update payment details

Create payment link

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.

Operations

Webhooks

Receive payment result notifications via Webhooks

The Computop Paygate API enables asynchronous event notifications through Webhooks, allowing your system to automatically receive the final result of a payment for hosted integration types, without the need for continuous polling.

Basic Webhook

Sends only the payId, allowing your system to fetch full payment details afterward.

Enhanced Webhook

Sends the complete payment information directly within the webhook payload.

For information on securing webhook communication, see the Security & verification section in the documentation.

Operations

Mobile SDK

Use the below endpoints if you are using Computop Paygate's mobile SDK for integration:

Create payment intent

This endpoint is used to generate a payment intent ID. You should call this endpoint from your backend to retrieve the payment intent ID to initialize the mobile SDK

Operations

Create payment intent

Request

This endpoint is used to create a payment intent

Security
bearerAuth or basicAuth
Bodyapplication/jsonrequired

Create payment intent

transIdstring<= 64 characters

Transaction ID created in your system. It should be unique for each payment.

externalIntegrationIdstring

External integration identifier

refNrstring

Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually.

amountobject(amount)
languagestring

Language code to determine the language of the payment form and customer communication where applicable.

captureMethodobject(captureMethod)
orderobject(order)
simulationModestring

Used to simulate a specific payment success or error use case. Accepts a list of predefined error codes.

urlsobject(urls)
billingAddressobject(billingAddress)
shippingobject(shipping)
statementDescriptorstring

Short, clear description of the transaction that appears on the customer's statement.

customerInfoobject(customerInfo)

Information about the customer.

partialPaymentboolean

Defines if the payment is a partial payment. Possible values: true or false.

expirationTimestring(date-time)

Transaction expiry timestamp (UTC).

Example: "2025-02-07T16:00:00Z"
fraudDataobject(fraudData)
paymentFacilitatorobject(paymentFacilitator)

Object specifying SubMerchant (Payment Facilitator) details.

browserInfoobject(browserInfo)
deviceobject(device)
credentialOnFileobject(credentialOnFile)
channelstring

Specifies the sales or interaction channel through which the transaction is initiated. Examples include "online", "in-store", "mobile app".

Enum"ECOM""MOTO""APP""PAYBYLINK""POS"
metadataobject

A collection of additional custom data provided by you to store extra information about the transaction. This is a set of JSON key value pairs passed by you. Paygate will return the data as it is in the response.

referencePayIdstring
curl -i -X POST \
  https://test.computop-paygate.com/api/v2/payment-intents \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transId": "6B29FC40-1067-B31D-00DD010662DA",
    "refNr": "24235345432",
    "partialPayment": false,
    "amount": {
      "currency": "EUR",
      "value": 10000
    },
    "language": "de",
    "captureMethod": {
      "type": "AUTOMATIC"
    },
    "order": {
      "merchantReference": "112-445-34567",
      "numberOfArticles": 1,
      "creationDate": "2025-03-31T11:58:37Z",
      "invoiceId": "555-333-2222",
      "description": "Order description",
      "items": [
        {
          "id": "1",
          "sku": "19-402-DEU",
          "name": "BatteryPowerPack",
          "quantity": 1,
          "quantityUnit": "pcs",
          "taxRate": 0,
          "netPrice": 1000,
          "grossPrice": 1000,
          "totalTaxAmount": 0,
          "totalDiscountAmount": 0,
          "description": "BatteryPowerPack",
          "type": "physical",
          "productInfo": {
            "brand": "Intel",
            "categories": [
              "Electronics Store",
              "Computers",
              "Desktops"
            ],
            "globalTradeItemNumber": "EAN",
            "manufacturerPartNumber": "BOXNUC5CPYA",
            "imageUrl": "https://www.exampleobjects.com/logo.png",
            "productUrl": "https://www.estore.com/products/f2a8d7e34"
          }
        }
      ]
    },
    "billingAddress": {
      "streetName": "Schwarzenbergstr",
      "streetNumber": "4",
      "city": "Bamberg",
      "country": "DEU",
      "postalCode": "96050"
    },
    "shipping": {
      "address": {
        "streetName": "Schwarzenbergstr",
        "streetNumber": "4",
        "city": "Bamberg",
        "country": "DEU",
        "postalCode": "96050"
      }
    },
    "statementDescriptor": "gadgets shop",
    "customerInfo": {
      "merchantCustomerId": "cus_1234567890abcdef",
      "customerType": "individual",
      "firstName": "Max",
      "lastName": "Mustermann",
      "email": "customer@example.com",
      "phone": {
        "countryCode": "+49",
        "number": "1236547890"
      },
      "salutation": "Ms",
      "title": "Dr",
      "gender": "female",
      "maidenName": "Mustermann",
      "middleName": "sam",
      "birthDate": "2001-01-01",
      "birthPlace": "Bamberg",
      "socialSecurityNumber": "123443534"
    },
    "channel": "ECOM"
  }'

Responses

Success

Bodyapplication/json
idstring
Response
application/json
{
  "id": "9106f92191c642f993a1c0b0025e4334"
}

Customers

Retrieve customers

This endpoint is used to retrieve a list of customers.

Retrieve customer

This endpoint is used to retrieve details of a specific customer.

Update customer data

This endpoint is used to update customer data.

Delete customer

This endpoint is used to delete a specific customer and associated payment methods.

Retrieve payment methods

This endpoint is used to retrieve all payment methods for a specific customer.

Retrieve payment method

This endpoint is used to retrieve details of a specific payment method.

Delete payment method

This endpoint is used to delete a specific payment method.

Operations

CloudPos

Use your web-based ERP or shop system to accept card payments in stationery businesses. The communication of your terminals at the point of sale occurs via the Internet directly through Computop Paygate and makes traditional interfaces such as OPI or ZVT superfluous.

Operations

Services

BIN Lookup

This endpoint is used to retrieve card country and DCC eligibility information based on the card BIN.

DCC - Quote

This endpoint is used to retrieve a Dynamic Currency Conversion (DCC) quote for a given transaction amount and card BIN.

Operations

Change log

2.2.0

  • Fixed 400 error code response body specs
  • Return order.invoiceId and order.merchantReference in Response if sent in request
  • Add order.description property to provide overall description for the order

2.1.0

  • Changed the name of the VIPPS payment method to VIPPSMOBILEPAY and add recurring payment support
  • Enhanced the get payment details response for the WERO payment method
  • Enhanced the card payment method response with cardholderConsentToStore
  • Updated the Bancontact payment method acquirer logic
  • Fixed the RATEPAY payment method tax rate calculation
  • Fixed the Customer Vault pseudoCardNumber and last4Digits issues
  • Removed unnecessary recurring object validation
  • Added support for the BIZUM payment method
  • Added support for the UNIONPAY payment method via PPRO
  • Added support for the ALIPAY payment method via PPRO
  • Added support for the WECHAT payment method via PPRO
  • Added support for the MBWAY payment method via PPRO
  • Added services/dcc/quote endpoint
  • Added services/dcc/bin-check endpoint
  • Enhanced the get payment details response for the CARD payment method (dccInfo object)
  • Enhanced the create payment hosted (dccEnabled parameter) and direct (dcc object) requests for the CARD payment method
  • Enhanced the create session request for the CARD payment method (dccEnabled parameter)

2.0.0

  • Initial version of REST API V2 Specification