menu

Payment API

What's on this page

In-person Payments / SoftPOS / Basic Operations / Refund A Payment / Card Not Present Refund

Refund: Card Not Present

The refund is initiated via the API, without the need for the customer to be physically present.

Following conditions apply to the Refund Card Not Present functionality:

  • Refunds exceeding the original transaction amount are not permitted.
  • Partial refunds are supported by specifying the desired amount in the API request.
  • The maximum refund period is 92 days.
    (in our test environment, this is limited to 2 days).
  • Depending on the acquiring contract, additional restrictions may apply:
    • Maximum amount per refund
    • Maximum refundable amount per day

API Request

  • End-point: /api/v1/refund
  • Method: POST​
  • Authentication: API Key
  • Request Headers
    • Content-Type: application/json​

Request parameters

Parameter Description
reference The unique reference for the payment transaction this payment is attempting to refund.
amount The refund amount (optional). If not provided, the Payment amount will be refunded.
details.cardPresent Must be false

Example 

{
  "reference": SP123456789ABC123456ABC123.A,
  "details": {
    "cardPresent": "false"
  }
}

API Response

Response parameters

Parameter Description
status The status of the refund.
reference An unique reference for the refund transaction, used to retrieve transaction result.
method Fixed value: softpos
type Fixed value: refund
language Echo from Payment.
currency Echo from Payment.
lastUpdate The local server datetime the refund was updated, epoch timestamp.
created The local server datetime the refund was created, epoch timestamp.
methodTransactionId A reference used to refund a payment (Card Present).
amount The refund amount.
merchantOrderReference Echo from Payment (if included).
brand Echo from Payment.
originalReference Echo from Request.
details.terminalId The terminal id as assigned by CCV.

Example 

{
  "status": "pending",
  "reference": "SP123456789ABC123456ABC123.B",
  "method": "softpos",
  "type": "refund",
  "language": "eng",
  "currency": "eur",
  "lastUpdate": 1761920500,
  "created": 1761920495,
  "methodTransactionId": "SP123456789ABC123456ABC123.A",
  "amount": 0.01,
  "merchantOrderReference": "Test1234",
  "brand": "visa",
  "originalReference": "SP123456789ABC123456ABC123.A",
  "details": {
    "terminalId": "123456"
  }
}

Get the transaction result

The refund status and receipts can be retrieved by fetching the transaction details via the Payment API.

API Request​

  • End-point: /api/v1/transaction
  • Method: GET​
  • Authentication: API Key
  • Request Headers
    • Content-Type: application/json​
  • Query parameter
    • reference: the reference of the response of the refund API request

API Response

Response parameters

Parameter Description
status The status of the refund.
reference An unique reference for the refund transaction, used to retrieve transaction result.
merchantOrderReference Echo from Payment (if included).
amount The refund amount.
type Fixed value: refund
currency Echo from Payment.
language Echo from Payment.
method Fixed value: softpos
brand Echo from Payment.
entryMode Fixed value: instore
methodTransactionId A reference used to refund a payment (Card Present).
created The local server datetime the transaction was created, epoch timestamp.
lastUpdate The local server datetime the transaction was updated, epoch timestamp.
statusFinalDate The local server datetime the transaction reached a final status, epoch timestamp.
originalReference The unique reference for the payment transaction this payment is attempting to refund.
details.terminalId The terminal id as assigned by CCV.
details.customerReceipt The receipt for the customer as an escaped JSON string. The content can be parsed to a JSON array
details.journalReceipt The journal receipt for the merchant as an escaped JSON string. The content can be parsed to a JSON array
details.eJournal The E-Journal for the merchant as an escaped JSON string. The content can be parsed to a XML.
details.receiptData Additional receipt data that can be parsed to JSON Object..

Example

{
  "status": "success",
  "reference": "SP123456789ABC123456ABC123.B",
  "merchantOrderReference": "Test1234",
  "amount": 0.01,
  "type": "refund",
  "currency": "eur",
  "language": "eng",
  "method": "softpos",
  "brand": "visa",
  "entryMode": "instore",
  "methodTransactionId": "SP123456789ABC123456ABC123.A",
  "created": 1761920495,
  "lastUpdate": 1761920500,
  "statusFinalDate": 1761920500,
  "originalReference": "SP123456789ABC123456ABC123.A",
  "details": {
    "terminalId": "123456",
    "customerReceipt": "[\"Customer's receipt\",\" \",\"CCV\",\"ARNHEM\",\" \",\"Terminal: ****3456\",\"Merchant: ****3456\",\" \",\"Retrieval reference: 123abc123\",\" \",\"Transaction: bfa7293e-3d9b-f9b3-887e-d37089e1b4d8\",\" \",\"MASTERCARD(a0000000041010)\",\"Card: xxxxxxxxxxxxx1234\",\"Card Sequence Nr: 00\",\" \",\"REFUND\",\"Date: 31/10/2025 15:11\",\"Auth. code: 123456\",\"Merchant Ref.: Test1234\",\" \",\"Total: 0.01 EUR\",\" \",\"ACCEPTED\"]",
    "journalReceipt": "[\"Merchant's receipt\",\" \",\"CCV\",\"ARNHEM\",\" \",\"Terminal: CT123456\",\"Merchant: 123456\",\" \",\"Retrieval reference: 123abc123\",\" \",\"Transaction: bfa7293e-3d9b-f9b3-887e-d37089e1b4d8\",\" \",\"MASTERCARD(a0000000041010)\",\"Card: xxxxxxxxxxxxx1234\",\"Card Sequence Nr: 00\",\" \",\"PAYMENT\",\"Date: 31/10/2025 15:11\",\"Auth. code: 123456\",\"Merchant Ref.: Test1234\",\" \",\"Total: 0.01 EUR\",\" \",\"ACCEPTED\"]",
    "eJournal": "<E-Journal><ShopInfo><CardAcceptorName>CCV</CardAcceptorName><CardAcceptorLocation>ARNHEM</CardAcceptorLocation><CardAcceptorIdentifier>123456</CardAcceptorIdentifier><TerminalIdentifier>CT123456</TerminalIdentifier></ShopInfo><TransactionInfo><TransactionIdentifier>bfa7293e-3d9b-f9b3-887e-d37089e1b4d8</TransactionIdentifier><ServiceLabelName>REFUND</ServiceLabelName><DateAndTime>31/10/2025 15:11</DateAndTime><AuthorisationCode>123456</AuthorisationCode><MerchantReference>Test1234</MerchantReference><TotalAmount Currency=\"EUR\">0.01</TotalAmount><TransactionResultText>ACCEPTED</TransactionResultText></TransactionInfo><CardInfo><ApplicationIdentifier>DEBIT MASTERCARD</ApplicationIdentifier><CardNumber>xxxxxxxxxxxxx1234</CardNumber><CardSequenceNumber>00</CardSequenceNumber></CardInfo></E-Journal>"
    "receiptData": "{\"transactionId\":\"bfa7293e-3d9b-f9b3-887e-d37089e1b4d8\",\"retrievalReferenceNumber\":\"123abc123\",\"merchantOrderReference\":\"Test1234\",\"terminalId\":\"CT123456\",\"merchantId\":\"123456\",\"merchantName\":\"CCV\",\"merchantLocation\":\"ARNHEM\",\"merchantLanguage\":\"eng\",\"aid\":\"a0000000041010\",\"brand\":\"DEBIT MASTERCARD\",\"cardPreferredName\":null,\"maskedCardNumber\":\"xxxxxxxxxxxxx1234\",\"panEnd\":\"1234\",\"cardSequenceNumber\":\"00\",\"transactionType\":\"refund\",\"timeStampUtc\":\"2025-10-31T14:11:45.213Z\",\"requestDateTimeFormatted\":\"31/10/2025 15:11\",\"amount\":1,\"amountFormatted\":\"0.01\",\"currency\":\"EUR\",\"authorisationCode\":\"123456\",\"acquirerResponse\":\"APPROVED\",\"cardholderVerificationMethod\":\"NONE\",\"posEntryMode\":\"CONTACTLESS\",\"localTransactionDateTimeIso\":\"2025-10-31T15:11:36\",\"localTransactionDateTimeFormatted\":\"31/10/2025 15:11\"}",
  }
}