menu

Payment API

What's on this page

Online Payments / Payment Methods / SoftPos

SoftPos

Shopper Country Sale Refund Authorise / Capture Void Token Vault Mandates
Selected few ✓ ✓

SoftPos is limited to the following countries: Netherlands, Belgium.

Introduction

SoftPos is a payment method that lets you accept contactless payments quickly and easily from a handheld device. This flexible payment solution enables contactless or PIN payments on NFC-capable Android devices that you already own. Integrate your POS or cash register software system through our Single API to provide a complete, fully mobile checkout experience.

Guidelines

  1. Create a payment with the payment method set to softpos and use a webhook or notification.
  2. This wil initiate the payment on the SoftPos app on the device. The customer can then pay by tapping their card or phone on the device.
  3. When CCV receives the payment confirmation from the SoftPOS app, the payment becomes successful.
  4. If you used a webhook or notification, CCV will inform you about the change. Alternatively, you can also query they payment status on regular intervals.

Method API details

Payment

Request

SoftPos requires a terminalId as method specific details.

{
    "amount": 9.99,
    "currency": "eur",
    "method": "softpos",
    "returnUrl": "https://shop/return?order=123456",
    "webhookUrl": "https://shop/payhook?order=123456",
    "merchantOrderReference": "123456",
    "description": "Order 123456",
    "language": "eng",
    "details": {
        "terminalId": "CT123567"
    }
}

Response

{
   "amount": 9.99,
   "created": 1776150518018,
   "currency": "eur",
   "description": "Order 123456",
   "details": {
      "terminalId": "CT123567"
   },
   "language": "eng",
   "lastUpdate": 1776150518045,
   "merchantOrderReference": "123456",
   "method": "softpos",
   "methodTransactionId": "3f49e9cd-f9a3-479c-b383-c6d78c90c20d",
   "reference": "SP260414070838014CB87E195.6",
   "returnUrl": "https://shop/return?order=123456",
   "status": "pending",
   "type": "sale"
}
SoftPos Payment Details

See SoftPos Payment Details for more information about the details fields for SoftPos payments.

Refunds

When refunding SoftPOS payments, 2 options are possible, as the original payment reference to refund is not required.

  1. A merchant can start a refund payment for method SoftPOS by providing the reference field in the refund request. Then all the details from the original payment are used for the refund. The merchant can optionally provide additional fields in the refund request.
  2. A merchant can start a refund payment for method SoftPOS by at least providing the amount, currency, language, details and method fields in the refund request. No reference to the original payment is required in this case. The refund will be processed as a new SoftPOS payment, but with the type refund. The details field must contain all the required details for a SoftPOS payment, as the details from the original payment are not used in this case.

With an original payment reference

example request for SoftPOS refund with original reference

curl --basic --user apikey: -H "Content-Type: application/json" --data '{
  "reference": "SP260414070838014CB87E195.6",
  "merchantOrderReference" : "123456"
}' https://api.psp.ccv.eu/api/v1/refund

Without an original payment reference

example request for SoftPOS refund without original reference

curl --basic --user apikey: -H "Content-Type: application/json" --data '{
  "method": "SOFTPOS",
  "currency": "EUR",
  "amount": 100.43,
  "language": "ENG",
  "merchantOrderReference" : "123456",
  "details": {
    "terminalId": "1234567",
    "cardPresent": "true",
  },
  "returnUrl" : "https://yourshop.com"
}' https://api.psp.ccv.eu/api/v1/refund