menu
Return to solutions

What's on this page

Basic Operations / Make A Payment

Warning

The Android REST API (CCV PayProxy application) is now in maintenance mode. This means that new integrations with the REST API are no longer possible. Existing users can continue using the API as usual. For any questions or issues regarding the REST API, please contact pi-support@ccvlab.eu.

Intro

This guide will walk you through the process to do a payment using the CCV PayProxy Android app.

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

Payment request object

The Payment object contains all information regarding a payment transaction on the terminal.

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 you would like to reserve for the charging session
currency  the currency for the transaction
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

Example authorisation request 

{
  "paymentType": "SALE",
  "requestId": "123456",
  "amount": 50.00,
  "currency": "EUR",,
  "terminalOperatingEnvironment": "UNATTENDED",
  "terminalAccessProtocol": "OPI_NL",
  "terminalLanguage": "ENG"
}

Response parameters

Parameter Description
status the status of your request
customerReceipt  a receipt with textlines for the customer
merchantReceipt  a receipt with textlines for the merchant
journalReceipt  a receipt with textlines for the merchant
eJournal a object containing all the information of a terminal transaction

Example authorisation response 

{
  "status": "SUCCESS",
  "amount": "50.00",
  "currency": "EUR",
  "card": "ECMC",
  "requestId": "1601951231",
  "stan": "00000593",
  "status": "SUCCESS",
  "timestamp": "2021-11-22T13:49:32.000+01:00",
  "customerReceipt": "[ \"Kopie Customer\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]",
  "merchantReceipt": "[ \"Kopie Merchant\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]",
  "journalReceipt": "[ \"Kopie Merchant\", \"\", \"******* PAS OP: TEST SYSTEEM *******\", "..."]",
  "eJournal": "<?xml version=\"1.0\"?>\n<E-Journal>\n...</E-Journal>"
}

For more information about all possible errorcodes please click here

Followup manuals