API Reference / Method

Method

Supported Methods

We support the following payment methods:

• Cards (Debit or Credit)
• iDEAL
• Sofort
• PayPal
• Giropay
• BankTransfer
• Terminal
• Payconiq
• Alipay
• Klarna
• Sepa Direct Debit
• Gift
• Apple Pay

Additionally our landing page method allows the customer to select a method of choice.

The keys for these are respectively card, ideal, sofort, paypal, giropay, banktransfer, terminal, payconiq, alipay, klarna, gift, sdd, applepay and landingpage.

Landing Page

A payment method where we provide the payment method selection for you.

After you create a landing page transaction, a customer can create a child transaction via the landing page form (where a method can be selected). This transaction can be retrieved using the childReferenceId value. A landing page transaction can have multiple attempts which may result in a child transaction. When a child transaction reaches a final transaction status such as success or manualintervention, the landing page (parent) transaction will be updated with the same status.

Typical Landing Page payment flow

The general flow will be:

1. You create a landingpage payment.
2. The customer reaches the landing page, chooses a payment method, makes the payment and returns to your shop.
3. We give feedback about status changes using Webhooks.

When the payment of the chosen method fails within 30 seconds, the customer can retry again using possibly another method.

The default expiration duration is P2M, which means:

• The customer will be redirected to your shop after this duration. For example, when he opens the payment link again.
• We start marking the payment as expired one day later. You will be notified with a webhook when the payment eventually expired.

Method preselection

It’s possible to preselect a payment method for landing page usage. This will attempt to create a new payment for this method when the customer accesses the landingpage via the payurl. The customer will be redirected to the method payment page right away without selecting a method. If the method is invalid, not available to the merchant or not allowed, the value will be disregarded and the landing page is displayed with all available methods.

Methods that do not support preselection:

• BankTransfer
• Klarna

Example of a landingpage payment request with a method preselection

{
  "amount" : 100.00,
  "currency" : "eur",
  "method" : "landingpage",
  "returnUrl" : "http://shop/?order=8cdbb73f-6537-4b7f-a6de-6ddab6c283e1",
  "metadata" : "my custom metadata",
  "merchantOrderReference" : "8cdbb73f-6537-4b7f-a6de-6ddab6c283e1",
  "description" : "API Payment description with method preselection ideal",
  "language" : "eng",
  "details" : {
   "expirationDuration" : "P0Y2M1DT0H0M0.000S",
   "preselectedMethod" : "ideal"
  }
}

Allowed Payment Methods

As a merchant can have multiple payment methods enabled for landing page use, the merchant can optimize the list by limiting the payment methods shown, or changing the default order.

Each method name must be correct, and at least one from the list must match an enabled payment method. The PSP ignores payment methods that are not available to the merchant.

Klarna is not supported If the merchant requests Klarna, it is ignored and not visible on the customers’ payment page.

Example of a landingpage payment request with a list of allowed payment methods

{
  "amount" : 20.00,
  "currency" : "eur",
  "method" : "landingpage",
  "returnUrl" : "http://shop/?order=8cdbb73f-6537-4b7f-a6de-6ddab6c283e1",
  "metadata" : "my custom metadata",
  "merchantOrderReference" : "8cdbb73f-6537-4b7f-a6de-6ddab6c283e1",
  "description" : "API Payment description with a list of methods to ",
  "language" : "eng",
  "details" : {
   "allowedPaymentMethods" : ["ideal", "gift"]
  }
}

Method request

The method request is used to return a list of available payment methods for the merchant. The list is a JSON array containing an item per method. Each item contains the method name and method specific options.

• Resource: /api/v1/method
• Method: GET
• Authentication: basic auth

Method response

• Status Code: 200
• Content Type: application/json

Example

curl https://api.psp.ccv.eu/api/v1/method -u apikey:

[
    {
        "method": "card",
        "options": [
            {
                "brand": "visa"
            },
            {
                "brand": "mastercard"
            },
            {
                "brand": "maestro"
            },
            {
                "brand": "bcmc"
            }
        ]
    },
    {
        "method": "ideal",
        "options": [
            {
                "group": "Nederland",
                "grouptype": "country",
                "issuerdescription": "Issuer Simulation V3 - ING",
                "issuerid": "INGBNL2A"
            },
            {
                "group": "Nederland",
                "grouptype": "country",
                "issuerdescription": "Issuer Simulation V3 - RABO",
                "issuerid": "RABONL2U"
            }
        ]
    },
    {
        "method": "sofort"
    },
    {
        "method": "paypal"
    },
    {
        "method": "landingpage"
    },
    {
        "method": "banktransfer"
    },
    {
        "method": "giropay",
        "options": [
            {
                "issuerdescription": "Test HBCI PIN/TAN Institut III",
                "issuerid": "TESTDETT310"
            },
            {
                "issuerdescription": "Deutsche Bank Fil Berlin",
                "issuerid": "DEUTDEDBBER"
            }
        ]
    },
    {
     "method": "payconiq",
     "options": [
            {
              "qr" : "true"
            }
        ]
    },
    {
    "method": "gift",
        "options": [
            {
                "giftacquirer" : "connect",
                "giftbrand" : "City Loyalty Deluxe"
            },
            {
                "giftacquirer" : "connect",
                "giftbrand" : "CCV Thanks Gift Card",
                "imageurl" : "http://ccvthanksbrand/imageurl.png"
            }
        ]
    },
    {
     "method": "klarna",
     "options": [
      {
       "qr" : "true"
      }
     ]
    },
    {
     "method": "sdd"
    },
  {
    "method": "applepay"
  }
]

Card

Supported Brands

iDEAL

iDEAL 1.0 specifications require you to group the issuers. You should group the items with the same group, as required by the iDEAL 1.0 specification (version 3.3.1). This is currently by country.

For iDEAL 2.0 the issuer selection is moved to the iDEAL environment. This means the method response no longer contains any issuer information.

!INFO The use of iDEAL 2.0 depends on your payment method configuration. Please contact ecommerce@ccv.eu for more information regarding iDEAL 2.0.

Sofort

Sofort currently has no options.

PayPal

PayPal currently has no options.

LandingPage

LandingPage currently has no options.

BankTransfer

BankTransfer currently has no options.

GiroPay

Terminal

Terminal currently has no options.

Payconiq

Klarna

Gift

SDD

SDD currently has no options.

Apple Pay

Apple Pay currently has no options.