REST API Cards

Cards are one of the most popular payment methods used globally. supports all major card brands that enables you to reach large percentage of customers worldwide.

Supported card brands:

AirPlus
American Express (AMEX)
Argencard
Bancontact
Cabal
Carte 4etoiles
Carte Helline
Carte Helline 4etoiles
Cartes Bancaires
Cencosud
Union Pay International (UPI)
Dankort
Diners
Discover
Elo
Girocard
Hipercard
Ikano
IKEA Family Paycard
JCB
Maestro
MasterCard
Naranja
RuPay
Shopping
Troy
Visa

Get started

Processing card payment method requires you to have a contract with a licensed acquirer.

supports processing of cards via wide range of acquirers:

Acquirer	Supported regions	Online payments	POS payments
1CS - First Cash Solution	Europe	Yes	Yes
Adyen	Australia Brazil Canada Europe Hong Kong Japan Malaysia New Zealand Puerto Rico Singapore United Arab Emirates United States	Yes	No
AIBMS	Europe	Yes	No
Airplus	Global	Yes	Yes
Amercian Express	Global	Yes	Yes
AsiaPay	China Australia India Indonesia Malaysia Philippines Singapore Taiwan Thailand Vietnam	Yes	No
Bank Frick	Europe	Yes	No
Banca Transilvania	Romania	Yes	Yes
Barclaycard	Europe	Yes	No
Be2bill/Dalenys	Europe	Yes	No
BNL Positivity	Europe	Yes	No
BNP Paribas	Europe	Yes	Yes
Payone	Europe	Yes	Yes
Card complete	Europe	Yes	No
Clearhaus (Unzer)	Europe	Yes	No
Concardis (Nets)	Europe	Yes	Yes
Finaro (Credorax)	Europe	Yes	No
Diners Club	Europe	Yes	No
EcomProcessing	Europe	Yes	No
Elavon Europe	Europe	Yes	Yes
Elavon US	USA Canada	Yes	No
EMS	Europe	Yes	No
eService	Poland	Yes	Yes
EVO Payments Europe	Europe	Yes	Yes
EVO Payments US	USA Canada	Yes	No
Firserv Europe	Europe	Yes	Yes
Fiserv APAC (IPG)	Australia	Yes	Yes
Fiserv US	USA	Yes	No
Global Payments	Europe Malta Israel Australia New Zealand Canada Singapore Hong Kong	Yes	No
GMO	Japan	Yes	No
HSBC	Europe	Yes	No
iCard	Europe	Yes	No
Ingenico	Europe	Yes	Yes
Intercard	Europe	Yes	No
JPMC Tampa (Direct to Tandem)	USA Canada	Yes	Yes
JPMC Salem (Stratus)	USA Canada	Yes	No
Nets (via Nets PG)	Europe	Yes	No
Handelsbanken (via Nets PG)	Europe	Yes	No
Swedbank (via Nets PG)	Europe	Yes	No
Rapyd (via Nets PG)	Europe	Yes	No
PagBrasil	Brasil	Yes	No
paygate.net	South Korea	Yes	No
Paynetics	Europe	Yes	No
PayPal	Global	Yes	No
PayU (Europe)	Poland Czech Rep. Slovakia Hungary	Yes	No
PayU CEE	Russia Romania Turkey	Yes	No
PayU Africa	South Africa Nigeria Kenya	Yes	No
PayU Latam	Argentina Brazil Chile Colombia Mexico Panama Peru	Yes	No
PayU India	India	Yes	No
PPRO	Europe	Yes	No
Raiffeisen Bank International	Eastern Europe	Yes	No
RedSys (Sabadell, La Caixa)	Spain	Yes	No
SIX	Europe	Yes	Yes
Nuvei (SafeCharge)	Europe	Yes	No
Worldpay (former Vantiv)	USA Canada	Yes	No
VR Payment	Europe	Yes	Yes
Worldline	Europe	Yes	No
Worldpay	Europe Australia	Yes	No

Once you have successfully onboarded with the Acquirer, reach out to to enable the payment method for you.

Integration options

Card payments are available in all 3 integration types we provide:

Hosted Payment Page: Initiate Hosted payment page by calling Create checkout session.

See full sample request

{
  "transId": "6B29FC40-1067-B31D-00DD010662DA",
  "refNr": "24235345432",
  "amount": {
      "currency": "EUR",
      "value": 10000
  },
  "language": "en",
  "captureMethod": {
      "type": "AUTOMATIC"
  },
  "order": {
      "merchantReference": "112-445-34567",
      "numberOfArticles": 1,
      "creationDate": "2025-03-31T11:58:37Z",
      "invoiceId": "555-333-2222",
      "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"
              }
          }
      ]
  },
  "urls": {
      "return": "https://my.callback.url.com/return",
      "cancel": "https://my.callback.url.com/cancel",
      "webhook": "https://my.callback.url.com/webhook"
  },
  "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": "Miss",
      "title": "Dr",
      "gender": "female",
      "maidenName": "Mustermann",
      "middleName": "sam",
      "birthDate": "2001-01-01",
      "birthPlace": "Bamberg",
      "socialSecurityNumber": "123443534"
  },
  "channel": "ECOM"
}

Hosted forms: Initiate card Hosted forms by calling Create payment with

{
  ...
  "paymentMethods": {
    "type": "CARD",
    "integrationType": "HOSTED"
  }
}

See full sampl,e request

{
  "transId": "6B29FC40-1067-B31D-00DD010662DA",
  "refNr": "24235345432",
  "amount": {
      "currency": "EUR",
      "value": 10000
  },
  "language": "en",
  "captureMethod": {
      "type": "AUTOMATIC"
  },
  "order": {
      "merchantReference": "112-445-34567",
      "numberOfArticles": 1,
      "creationDate": "2025-03-31T11:58:37Z",
      "invoiceId": "555-333-2222",
      "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"
              }
          }
      ]
  },
  "urls": {
      "return": "https://my.callback.url.com/return",
      "cancel": "https://my.callback.url.com/cancel",
      "webhook": "https://my.callback.url.com/webhook"
  },
  "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"
      }
  },
  "channel": "ECOM",
  "paymentMethods": {
      "integrationType": "HOSTED",
      "type": "CARD"
  }
}

Direct integration: Initiate card Direct integration by calling Create payment with

{
  ...
  "paymentMethods": {
    "integrationType": "DIRECT",
    "type": "CARD",
    "card": {
        "number": "4242424242424242",
        "cardHolderName": "Max Mustermann",
        "expiryDate": "202801",
        "brand": "VISA",
        "securityCode": "123"
    }
  }
}

See full sample request

{
  "transId": "6B29FC40-1067-B31D-00DD010662DA",
  "refNr": "24235345432",
  "amount": {
      "currency": "EUR",
      "value": 10000
  },
  "captureMethod": {
      "type": "AUTOMATIC"
  },
  "browserInfo": {
      "acceptHeaders": "text",
      "ipAddress": "93.176.166.240",
      "javaEnabled": false,
      "javaScriptEnabled": true,
      "language": "EN",
      "userAgent": "Mozilla/5.0",
      "colorDepth": 4,
      "screenHeight": 800,
      "screenWidth": 1200,
      "timezoneOffset": "120"
  },
  "order": {
      "merchantReference": "112-445-34567",
      "numberOfArticles": 1,
      "creationDate": "2025-03-31T11:58:37Z",
      "invoiceId": "555-333-2222",
      "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"
      }
  },
  "channel": "ECOM",
  "paymentMethods": {
      "integrationType": "DIRECT",
      "type": "CARD",
      "card": {
          "number": "4242424242424242",
          "cardHolderName": "Max Mustermann",
          "expiryDate": "202801",
          "brand": "VISA",
          "securityCode": "123",
          "brandSelection": "MERCHANT"
      }
  }
}

Reverse payment

You can reverse a card transaction if it has not yet been captured. Reversals release the authorization hold on the cardholder’s account, ensuring they are not charged.

To perform a reversal, call the Reverse payment endpoint with the payId of the original transaction.

Capture payment

If your initial card payment was submitted with captureMethod.type=MANUAL, you must manually capture the funds after authorization.

Call the Capture payment endpoint using the payId from the original transaction.

Refund payment

Refunds can be performed for card payments either with reference (linked to the original transaction) or without reference (standalone).

Refund with reference

Use this when the refund is tied to a previously captured transaction. Call the Refund payment endpoint and provide the payId.

Refund without reference

For standalone refunds (e.g., offline settlement adjustment), use the Refund payment without reference. Since there is no relation to the payment, these refunds should be submitted as a completely new transaction.

Contact to enable this feature for you if needed.

Refunds without reference to original payments attract higher costs from your acquirer. If you frequently cannot reference the refund to the original payment, you should consult your acquirer.

Page tree