menu

Payment API

What's on this page

Online Payments / Basic Operations / Query The Payment Status

Query the payment status

A payment starts with status pending and finally becomes success or failed.

In the case an unexpected situation occurs, status manualintervention is assigned to the payment. Contact the helpdesk with the payment reference in that cases.

Use CCV’s payment reference

CCV generates a unique reference per payment. You can use that reference to query the status of the payment.

Example request

curl --basic --user apikey: https://api.psp.ccv.eu/api/v1/transaction?reference=C240305064258677CB87E192.G

Example response

{
  "lastUpdate": 1709621105740,
  "statusFinalDate": 1709621105740,
  "cancelUrl": "https://onlinepayments.ccv.eu/card/cancel/merchant?reference=C240305064258677CB87E192.G",
  "created": 1709620979582,
  "methodTransactionId": "tMuzqg",
  "entryMode": "ecom",
  "brand": "visa",
  "details": {
    "cardholderFirstName": "John",
    "initialTransactionId": "p3GNcBD4tLFo800",
    "qrCode": "https://shop-vpos-test.ccvlab.eu/bep/authenticate.html?secureTransferId=1d584a8f-58fc-4704-a92d-9955e678b932&trm=50",
    "maskedPan": "4111XXXXXXXX1111",
    "acquirerResponseCode": "00",
    "urlIntent": "https://shop-vpos-test.ccvlab.eu/bep/authenticate.html?secureTransferId=1d584a8f-58fc-4704-a92d-9955e678b932&trm=51",
    "authorisedAmount": 9.99,
    "acquirer": "Valitor",
    "cardholderLastName": "Doe",
    "authenticationProtocol": "3DS2",
    "authenticationStatus": "Y",
    "acquirerResponseCodeDescription": "ApprovedOrCompletedSuccessfully"
  },
  "payUrl": "https://onlinepayments.ccv.eu/card/payment.html?reference=C240305064258677CB87E192.G",
  "amount": 9.99,
  "description": "Order 123456",
  "status": "success",
  "reference": "C240305064258677CB87E192.G",
  "merchantOrderReference": "123456",
  "method": "card",
  "type": "sale",
  "language": "eng",
  "currency": "eur",
  "returnUrl": "https://shop/return?order=123456"
}

Use your payment reference

You can provide a reference per payment, unique or not, in the field merchantOrderReference. You can use that reference to query the status of the payment.

Warning

The response is a JSON array instead of a single object!

Example request

curl --basic --user apikey: https://api.psp.ccv.eu/api/v1/transaction?merchantOrderReference=123456

[
  {
    "lastUpdate": 1709816402041,
    "statusFinalDate": 1709816402041,
    "failureCode": "expired",
    "cancelUrl": "https://onlinepayments-accept.ccv.eu/googlepay/cancel?reference=GP240306095831302CB87E192.B",
    "created": 1709719111493,
    "merchantOrderReference": "123456",
    "notificationRequests": [],
    "entryMode": "ecom",
    "returnUrl": "https://bo-accept.psp.ccv.eu/mbo/#!/",
    "details": {},
    "payUrl": "https://onlinepayments-accept.ccv.eu/googlepay/payment.html?reference=GP240306095831302CB87E192.B",
    "amount": 0.10,
    "status": "failed",
    "description": "Order 123456",
    "reference": "GP240306095831302CB87E192.B",
    "method": "googlepay",
    "type": "sale",
    "language": "eng",
    "currency": "eur"
  },
  {
    "originalReference": "C240305064258677CB87E192.G",
    "lastUpdate": 1709621334942,
    "statusFinalDate": 1709621334942,
    "created": 1709621334478,
    "methodTransactionId": "tMuzqg",
    "merchantOrderReference": "123456",
    "notificationRequests": [],
    "entryMode": "ecom",
    "returnUrl": "https://shop/return?order=123456",
    "brand": "visa",
    "details": {
      "initialTransactionId": "p3GNcBD4tLFo800",
      "acquirerResponseCode": "00",
      "authorisedAmount": 9.99,
      "acquirer": "Valitor",
      "acquirerResponseCodeDescription": "ApprovedOrCompletedSuccessfully"
    },
    "amount": 5.31,
    "status": "success",
    "description": "Order 123456",
    "reference": "C240305064854420CB87E193.G",
    "method": "card",
    "type": "capture",
    "language": "eng",
    "currency": "eur"
  }
]

It’s possible to include all the successful related transactions by querying the status of the payment. Add the query parameter includeRelatedTransactions with value true.

All direct related transactions are found in the field relatedTransactions of the response. Take note that only the directly related transactions are shown. e.g. A refund on a capture is not shown on the authorise.

Also take in mind that only successful transactions are returned.

Example request

curl --basic --user apikey: https://api.psp.ccv.eu/api/v1/transaction?reference=L241029143904193CB87E197.L&includeRelatedTransactions=true

[
  {
    "lastUpdate": 1730209167858,
    "statusFinalDate": 1730209167858,
    "cancelUrl": "https://onlinepayments.ccv.eu/api/v1/cancel?reference=L241029143904193CB87E197.L",
    "created": 1730209144199,
    "methodTransactionId": "04bFwt",
    "entryMode": "ecom",
    "details": {
      "expirationDuration": "P0Y2M1DT0H0M0.000S",
      "allowCustomerCancel": true
    },
    "payUrl": "https://onlinepayments.ccv.eu/landingpage/payment.html?reference=L241029143904193CB87E197.L",
    "amount": 50.00,
    "description": "Order 123456",
    "relatedTransactions": [
      {
        "type": "sale",
        "amount": 30.00,
        "status": "success",
        "reference": "C241029143922873CB87E195.L",
        "created": 1730209162922,
        "lastUpdate": 1730209167606,
        "statusFinalDate": 1730209167606,
        "method": "card"
      },
      {
        "type": "sale",
        "amount": 50.00,
        "status": "success",
        "reference": "GF241029143918340CB87E194.L",
        "created": 1730209158386,
        "lastUpdate": 1730209158816,
        "statusFinalDate": 1730209158816,
        "method": "gift"
      }
    ],
    "childReferenceId": "C241029143922873CB87E195.L",
    "status": "success",
    "reference": "L241029143904193CB87E197.L",
    "merchantOrderReference": "123456",
    "method": "landingpage",
    "type": "sale",
    "language": "nld",
    "currency": "eur",
    "returnUrl": "https://shop/return?order=123456"
  }
]