menu
Return to solutions

What's on this page

Payment Features / Capture

Capture

If you completed an authorisation, you’re almost there to finalise the transaction.
The capture request will finish the transaction and will transfer the amount from the shopper to your account.

Have a look at Authorise if you don’t know when you need an authorisation-capture.

Make an capture request

The api-method to achieve this is the HTTP.POST with url ‘/terminal/payment’

Request headers

  • Content-Type: application/json

Request parameters

Parameter Description
paymentType the type of the payment.
requestId requestId used to identify the transaction on the terminal, this must be an Integer between 0 and 1000000000
amount  the amount that needs to be paid for the charging session. This value can be the same or less than the authorised amount.
currency  the currency for the transaction
authReference the reference to an authorised transaction
 authReferenceVersion  the version of the authReference
terminalOperatingEnvironment the configuration of the terminal that you would like to use for this transaction
terminalAccessProtocol the protocol to communicate with the terminal
terminalLanguage the language for the texts that are going to be displayed on the terminal
terminalEnvironment the environment of your solution. Examples: EVCHARGING, CARPARKING, PETROL
captureCancellationReasonCode the capture cancellation reason code. Examples: NO_ERROR, DISPENSER_BACK_OFFICE_SYSTEM_NOT_RESPONDING_TO_REQUEST, AVAILABLE_FUNDS_TOO_SMALL_TO_DELIVER,CLIENT_DID_NOT_TAKE_PRODUCT_IN_TIME, DISPENSER_BACK_OFFICE_SYSTEM_INTERNAL_FAILURE, WRONG_PRODUCT, UNEXPECTED_OPERATION_RESULT, AMOUNT_ZERO_OR_NO_VOLUME

Example request

{
  "paymentType": "CAPTURE",
  "requestId": "123456",
  "amount": 25.00,
  "currency": "EUR",
  "authReference": "H4sIAAAAAAAAA6tWcs7PLchJLUlNCShKdSwt",
  "authReferenceVersion": "1",
  "terminalOperatingEnvironment": "UNATTENDED",
  "terminalAccessProtocol": "OPI_NL",
  "terminalLanguage": "ENG",
  "terminalEnvironment": "EVCHARGING"
}

Example response

{
   "status": "SUCCESS",
   "customerReceipt": "[ \"Kopie Kaarthouder\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]",
   "journalReceipt": "[ \"Kopie Merchant\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]",
   "eJournal": "<?xml version=\"1.0\"?>\n<E-Journal>\n...</E-Journal>"
}

Followup manuals