Skip to content

Payment REST API

Payment REST API is currently a beta release

Use the Payment REST API for integrating from your servers.

Security

All requests on the Payment REST API must be secured, therefore all calls are required to be compliant with TLS 1.2 or later. Follow the JWT guide on how to acquire a Bearer Token.

Processing a payment transaction

To process a transaction, send a HTTP/1.1 request to the correct API end-point in JSON format. Below example shows a request and the response.

Example request

POST /v2/merchants/1570616552/orders/order_example_1 HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer 573cec25a87526dcceacad786bbbba83b1a5172

{
  "orderDescription": "description",
  "orderDetailDescription": "detailed desc",
  "paymentMethodId": 1000,
  "amount": {
    "currency": "EUR",
    "amount": 10.50
  },
  "autoCapture": false,
  "transactionChannel": "Web Online",
  "cardInfo": {
    "cardNumber": "4111111111111111",
    "expirationDate": "12-2024"
  },
  "cardVerificationInfo": {
    "cvCode": "123",
    "cvCodeState": "USED"
  }
}

Example response

{
    "mid": 1570616552,
    "orderId": "order_example_1",
    "orderDetailDescription": "detailed desc",
    "orderDescription": "description",
    "orderAmount": 10.50,
    "fulfilmentAmount": 10.50,
    "capturedAmount": 0.00,
    "refundedAmount": 0.00,
    "currency": "EUR",
    "baseCurrency": "EUR",
    "baseOrderAmount": 10.50,
    "baseFulfilmentAmount": 10.50,
    "baseCapturedAmount": 0.00,
    "baseRefundedAmount": 0.00,
    "capturable": true,
    "cancelable": true,
    "refundable": false,
    "completable": false,
    "dccIndicator": false,
    "transactionReferences": [
        {
            "transactionId": 5986908782,
            "transactionTypeId": 1,
            "mid": 1570616552,
            "orderId": "order_example_1",
            "transactionType": "Authorize",
            "transactionDate": "2019-10-04T14:05:26.927Z",
            "transactionDesc": "Transaction accepted",
            "statusCode": 0,
            "status": "Processed",
            "amount": 10.50,
            "currency": "EUR",
            "baseAmount": 10.5,
            "baseCurrency": "EUR",
            "paymentMethod": "Visa",
            "paymentMethodId": 1001,
            "acquirerAuthorizationCode": "123456",
            "acquirerReferenceId": "622135",
            "acquirerAnswerCode": "00",
            "bankReferenceId": "622135",
            "bankAnswerCode": "00",
            "maskedAccountNumber": "411111xxxxxx1111",
            "cardExpiryDate": "2024-12",
            "cvResponse": "",
            "cvAnswerCode": 2,
            "avsResponse": "",
            "avsAnswerCode": 3
        }
    ]
}