Sending commands to the POS terminal.
Defines the type of payment: Supported values are: 01 - Sale; 02 - Reverse; 03 - Credit; 05 - Authorization/Reservation; 0B - Capture; 0C - Card Read; 0D - Diagnose; A1 - Terminal Startup.
Your unique reference number for the specific operation. You can pass this value to reconcile different operations in a payment (authorization, capture, refund, etc) individually.
Defines the technology to be used to read the card. Valid values are: msr.
Mandatory for subsequent functions Reversal or Capture (MessageType=02/08). It must be equal to the value traceNr received from the original authorization response. Merchant POS system must provide this in the request.
Mandatory for subsequent function Capture (MessageType=08). It must be equal to the value approvalCode received from the original authorization response. Merchant POS system must provide this in the request.
- Testhttps://test.computop-paygate.com/api/v2/cloudpos
- Productionhttps://www.computop-paygate.com/api/v2/cloudpos
curl -i -X POST \
-u '<username>:<password>' \
https://test.computop-paygate.com/api/v2/cloudpos \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: string' \
-H 'X-API-Key: YOUR_API_KEY_HERE' \
-d '{
"transId": "435345423",
"messageType": "SALE",
"refNr": "42342344",
"amount": {
"value": 5000,
"currency": "EUR"
},
"posTerminalId": "987654321",
"cardReadMode": "MSR",
"localDateTime": "2025-10-13T15:05:06",
"traceNr": "3543534",
"approvalCode": "T454353",
"credentialOnFile": {
"initialPayment": true,
"type": "UNSCHEDULED",
"unscheduled": {
"subType": "CIT"
}
},
"contractId": "overidden_merchantId"
}'Created
A unique identifier assigned by Computop Paygate to the payment. This ID remains constant throughout the lifecycle of the payment and is used to track and reference the payment across all subsequent operations, such as authorization, capture, refund, or cancellation.
Trace number. Merchant must save this value form the response and use it when referencing subsequent actions i.e Reverse, Capture.
Additional text which the operator’s processing system can send optionally in replies to payment/cutover requests.
Approval code from authorization host in the response message to the client. Only in case of successful credit card transactions. Merchant must save this value form the response and use it when referencing Capture subsequent action.
Authorisation parameters: if these are present, the authorisation parameters must be printed out on the terminal receipt in unpacked form as 10 hexadecimal numbers. Aid-parameters can contain up to 130 characters for electronic cash payments.
Used authentication mode. Possible values: Signature; PIN; On consumer device; NoAuth.
Data containing the receipt information which can be printed out by the merchant system.
{ "status": "OK", "responseDescription": "success", "refNr": "42342344", "payId": "234234-24524-2342-2324", "merchantId": "demo_test", "transId": "01TransIdTest", "contractId": "01ContractIDTest", "terminalId": "2342342", "posTerminalId": "82623104", "providerResponseCode": "201", "traceNr": "3543534", "vuNr": "10344", "additionalResponseData": "some additional data", "approvalCode": "T454353", "localDateTime": "2030-08-30T15:04:59", "aidParamaters": "5423423423423JDISOOS432423", "verificationCode": "PIN", "receipt": { "receiptNr": "432423", "receiptMerchant": "Merchant: Demo Test, Terminal ID: 12425423, Location: Store 123", "receiptCustomer": "Customer Name: John Doe, Date: 2025-02-10, Amount: 5000 EUR", "receiptCopies": 2, "receiptsNumber": 10234 }, "dcc": { "foreignAmount": 1000, "foreignCurrencyCode": "AED", "commission": "123", "margin": "2432", "rateValue": "23423", "source": "some source", "timestamp": "2025-02-27T15:05:06", "disclaimerText": "some text" }, "credentialOnFile": { "type": "UNSCHEDULED", "initialPayment": true, "unscheduled": { … } }, "paymentMethod": { "card": { … }, "directDebit": { … } } }