Skip to content

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
bearer and basic and apiKey
Bodyapplication/jsonrequired
transIdstring

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. It is recommended to limit the length to 18 characters so that it works for all payment methods. Allowed characters: letters (A-Z, a-z), digits (0-9), and the special characters - ? , ( ) + . ' :

amountobject(amount)
languagestring

Language code to determine the language of the payment form and customer communication where applicable. Use 2 letter ISO language codes for common languages such as en for English, de for German, etc. For variations of languages use 5 letter code such as fr-be for French language in Belgium.

captureMethodobject(captureMethod)
orderobject(order)
urlsobject(intentUrls)
billingAddressobject(billingAddress)
shippingobject(shipping)
statementDescriptorstring

Short, clear description of the transaction that appears on the customer's statement. It is recommend sending a maximum of 22 characters. Allowed characters: a-z, A-Z, 0-9, spaces, and special characters / - ? : ( ) . , +

customerInfoobject(customerInfo)

Information about the customer.

expirationTimeany, (date-time)

Transaction expiry timestamp (UTC).

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

Object specifying SubMerchant (Payment Facilitator) details.

partialPaymentboolean

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

deviceobject(device)
credentialOnFileobject(credentialOnFile)
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.

paymentMethodsobject(paymentCreateIntent)
curl -i -X POST \
  -u '<username>:<password>' \
  https://test.computop-paygate.com/api/v2/payment-intents \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -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",
    "paymentMethod": {
      "card": {
        "eventToken": "ORDER",
        "dccEnabled": false
      }
    }
  }'

Responses

Success

Bodyapplication/json
idstringrequired
Response
{
  "id": "9106f92191c642f993a1c0b0025e4334"
}