menu

Payment API

What's on this page

API Reference / Transaction Query

Transaction

A transaction can be a Payment (Sale, Credit, Authorise), Refund, Capture, Token or Vault transaction depending on the type.

Read single transaction request

  • Resource: /api/v1/transaction?reference={reference}
  • Method: GET
  • Authentication: basic auth
  • Parameters:
Name Required Description
reference Yes The unique reference of the transaction, max 255
includeRelatedTransactions No Show all successful related transactions

Read single transaction response

Read collection of transactions request

  • Resource: /api/v1/transaction
  • Method: GET
  • Authentication: basic auth
  • Parameters
Name Required Description
referenceBefore No Returns previous payments before this reference
referenceAfter No Returns next payments after this reference
references No Returns the payments that have a references in this list. Example value: reference1,reference2,..
originalReferences No Returns the payments that are a refund, capture or reversal of another payment with reference in this list. Example value: originalReference1,originalReference2,..
merchantOrderReference No Returns payments with the exact same merchant order reference
createdBefore No Returns payments created before this timestamp, excluding payments with this create timestamp
createdAfter No Returns payments created after this timestamp, excluding payments with this create timestamp
amountMinimum No Returns payments with the same or a greater amount
amountMaximum No Returns payments with the same or a smaller amount
type No Returns payments with the same type. Possible values: sale, refund, token, credit, authorise, capture or vault
method No Returns payments with the same method. Possible values: Supported Methods
status No Returns payments with the same status. Possible values: Transaction Status
paidout No Returns payments with the same paidout status. This can be yes for all payments, no for transactions that are not yet paid out, and never for transactions that are not collecting. Possible values: yes, no, or never
paidoutAfter Conditional Returns payments paidout after this timestamp, excluding payments with this paidout timestamp
paidoutBefore Conditional Returns payments paidout before this timestamp, excluding payments with this paidout timestamp
unstructuredReference No Returns payments with the same collector payment reference. Only valid for collecting protocols
paidoutReference No Returns the transactions related to that paidoutReference. Can be used to find the transactions that form the payment to the merchant. Only valid for collecting protocols
orderBy No Returns payments ordered by a property. Possible values: reference, created or amount, default: created
order No Returns payments ordered by the direction. Possible values: asc or desc, default: desc
count No Limits the returned payments to the count. Default & maximum: 500

Paging when reading a collection of transactions

We do not support paging using a page parameter, but provide parameters to implement a sliding window. If the response list has the same count as you requested, you may request the next page by using the referenceBefore or the referenceAfter parameter with the data of the first or last item in the list, respectively. The default & maximum value for the count parameter is 500. Changing this value, changes the size of the sliding window.

Read collection of transactions response

  • Status Code: 200
  • Content Type: application/json
  • Content: A JSON array of Transactions

Example

# First 100 transactions created after 2015/01/01 01:01:01.000, sorted ascending
curl https://api.psp.ccv.eu/api/v1/transaction?createdAfter=1420074061000&count=100&order=asc -u apikey:

[
  {
    "type" : "sale",
    "amount" : 316.35,
    "currency" : "eur",
    "status" : "success",
    "merchantOrderReference" : "CFED8B1C8B9F292500E2E837767900BF2448EE28",
    "description" : "A description for an order",
    "language" : "eng",
    "method" : "card",
    "brand" : "visa",
    "metadata" : "CFED8B1C8B9F292500E2E837767900BF2448EE28",
    "returnUrl" : "http://shop?order=CFED8B1C8B9F292500E2E837767900BF2448EE28",
    "entryMode" : "ecom",
    "reference" : "AC130090D6C19A09CD4B8B3EECCE199AD895B6E0",
    "created" : 1420106400000,
    "lastUpdate" : 1420106700000,
    "statusFinalDate" : 1420106700000
  }, {
    "type" : "sale",
    "amount" : 316.35,
    "currency" : "eur",
    "status" : "success",
    "paidout" : "yes",
    "merchantOrderReference" : "f1699892-25eb-4c1c-9cc3-3e345ccc1cec",
    "description" : "A description for an order",
    "language" : "nld",
    "method" : "ideal",
    "metadata" : "I1506151348179039.1",
    "reference" : "I1506151348179039.1",
    "created" : 1434368898588,
    "lastUpdate" : 1434368901391,
    "statusFinalDate" : 1434368901391,
    "payUrl" : "https://idealtest.secure-ing.com/ideal/issuerSim.do?trxid=0050000101228409&ideal=prob",
    "returnUrl" : "http://shop?order=f1699892-25eb-4c1c-9cc3-3e345ccc1cec",
    "entryMode" : "ecom"
  }
]

Second Example

# Payments with references:  C1507300954022980.1,C1507300955272271.1,I1507301136243800.1,I1507301136354361.1
curl https://api.psp.ccv.eu/api/v1/transaction?references=C1507300954022980.1,C1507300955272271.1,I1507301136243800.1,I1507301136354361.1 -u apikey:

[ {
  "type" : "sale",
  "amount" : 0.40,
  "currency" : "eur",
  "status" : "success",
  "merchantOrderReference" : "ca47e7aa-5d57-42e3-bb53-532006c93d9c",
  "description" : "API Payment description",
  "language" : "nld",
  "method" : "ideal",
  "metadata" : "ca47e7aa-5d57-42e3-bb53-532006c93d9c",
  "reference" : "I1507301136354361.1",
  "created" : 1438248996081,
  "lastUpdate" : 1438249968771,
  "statusFinalDate" : 1438249968771,
  "payUrl" : "https://onlinepayments.ccv.eu",
  "returnUrl" : "http://shop?order=f1699892-25eb-4c1c-9cc3-3e345ccc1cec",
  "entryMode" : "ecom",
  "paidout" : "yes",
  "unstructuredReference" : "AFREK. CPSPi BCMC DAT. 20150730/5211 AANT. 2 MREF. Joury Gokel"
}, {
  "type" : "sale",
  "amount" : 0.20,
  "currency" : "eur",
  "status" : "success",
  "merchantOrderReference" : "e3c56b80-c97c-48b7-91ec-67262e99c628",
  "description" : "API Payment description",
  "language" : "nld",
  "method" : "ideal",
  "metadata" : "e3c56b80-c97c-48b7-91ec-67262e99c628",
  "reference" : "I1507301136243800.1",
  "created" : 1438248985129,
  "lastUpdate" : 1438249968768,
  "statusFinalDate" : 1438249968771,
  "payUrl" : "https://onlinepayments.ccv.eu",
  "returnUrl" : "http://shop?order=f1699892-25eb-4c1c-9cc3-3e345ccc1cec",
  "entryMode" : "ecom",
  "paidout" : "yes",
  "unstructuredReference" : "AFREK. CPSPi BCMC DAT. 20150730/5211 AANT. 2 MREF. Joury Gokel"
}, {
  "type" : "sale",
  "amount" : 0.15,
  "currency" : "eur",
  "status" : "success",
  "merchantOrderReference" : "0c01096f-4122-4dd9-be49-5872a1fb91ad",
  "description" : "API Payment description",
  "language" : "nld",
  "method" : "card",
  "metadata" : "0c01096f-4122-4dd9-be49-5872a1fb91ad",
  "reference" : "C1507300955272271.1",
  "created" : 1438242927232,
  "lastUpdate" : 1438246838175,
  "statusFinalDate" : 1438246838175,
  "payUrl" : "https://onlinepayments.ccv.eu",
  "returnUrl" : "http://shop?order=f1699892-25eb-4c1c-9cc3-3e345ccc1cec",
  "entryMode" : "ecom",
  "brand" : "bcmc",
  "token" : "93333333333333076",
  "tokenMaskedInput" : "4111XXXXXXXX1111",
  "paidout" : "yes",
  "unstructuredReference" : "AFREK. CPSPi BCMC DAT. 20150730/5211 AANT. 1 MREF. Joury Gokel"
}, {
  "type" : "sale",
  "amount" : 316.35,
  "currency" : "eur",
  "status" : "pending",
  "merchantOrderReference" : "0c01096f-4122-4dd9-be49-5872a1fb91ad",
  "description" : "API Payment description",
  "language" : "nld",
  "method" : "card",
  "metadata" : "0c01096f-4122-4dd9-be49-5872a1fb91ad",
  "reference" : "C1507300954022980.1",
  "created" : 1438242842320,
  "lastUpdate" : 1438242842320,
  "statusFinalDate" : 1438242842320,
  "payUrl" : "https://onlinepayments.ccv.eu",
  "returnUrl" : "http://shop?order=f1699892-25eb-4c1c-9cc3-3e345ccc1cec",
  "entryMode" : "ecom",
  "token" : "PENDING"
} ]