POST api/tt_doc_sa/vip-split/payment/reject-terminal

Request Information

URI Parameters

None.

Body Parameters

VipSplitTerminalPaymentRejectRequest
NameDescriptionTypeAdditional information
PaymentGroupId

globally unique identifier

None.

PaymentOwnerToken

globally unique identifier

None.

DocumentId

globally unique identifier

None.

PaymentOperationId

globally unique identifier

None.

TerminalResponse

socket_event_transaction_response_api

Required

CoordinatorControlVersion

Collection of byte

Required

Max length: 8

Min length: 8

PartControlVersion

Collection of byte

Required

Max length: 8

Min length: 8

Request Formats

application/json, text/json

Sample:
{
  "paymentGroupId": "ded487ba-d63c-4580-b545-cfbc356d148a",
  "paymentOwnerToken": "11d70436-2dd6-4994-a410-f94cb53b0413",
  "documentId": "00fcd6aa-fff9-49a2-a7e7-00e0f486baab",
  "paymentOperationId": "ec5ab7c9-2e05-4fe2-a027-70484bc44978",
  "terminalResponse": {
    "$id": "2",
    "error": true,
    "action": "sample string 2",
    "status": "sample string 3",
    "method": "sample string 4",
    "message_code": "sample string 5",
    "message": "sample string 6",
    "payload": {
      "$id": "3",
      "action": "sample string 1",
      "locator": "sample string 2",
      "orderId": "sample string 3",
      "terminal": "sample string 4",
      "data": {
        "$id": "4",
        "orderId": "sample string 1",
        "amount": 2.1,
        "printReceipt": 3,
        "transactionId": "sample string 4"
      },
      "metadata": {
        "$id": "5",
        "back_color": "sample string 1",
        "order": 2
      },
      "result": {
        "$id": "6",
        "deviceId": "sample string 1",
        "transactionId": "sample string 2",
        "transactionType": "sample string 3",
        "amount": 4,
        "currencyCode": "sample string 5",
        "transactionNumber": "sample string 6",
        "result": 7,
        "status": 8,
        "paymentApp": "sample string 9",
        "additionalData": {
          "$id": "7",
          "orderId": "sample string 1",
          "transactionData": {
            "$id": "8",
            "type": "sample string 1",
            "card": "sample string 2",
            "terminal": "sample string 3",
            "transactionDate": "sample string 4",
            "state": "sample string 5",
            "result": "sample string 6",
            "responseCode": "sample string 7",
            "authorizationNumber": "sample string 8",
            "cardType": "sample string 9",
            "transactionCounter": "sample string 10",
            "appId": "sample string 11",
            "appLabel": "sample string 12",
            "isPinAuthenticated": true,
            "isContactless": true,
            "capturedMode": 15,
            "authorisingCentre": "sample string 16",
            "fucId": "sample string 17",
            "arc": "sample string 18",
            "transactionReference": "sample string 19",
            "authenticationType": 20,
            "transactionCurrencyCode": "sample string 21",
            "location": "sample string 22",
            "fucName": "sample string 23",
            "modifiers": [
              {
                "$id": "9"
              },
              {
                "$ref": "9"
              }
            ],
            "originalTransactionId": "sample string 24"
          }
        }
      }
    },
    "metadata": {
      "$ref": "5"
    }
  },
  "coordinatorControlVersion": "QEA=",
  "partControlVersion": "QEA="
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VipSplitProcessResponse
NameDescriptionTypeAdditional information
PaymentGroupId

globally unique identifier

None.

ActivityId

globally unique identifier

None.

CoordinatorDocumentId

globally unique identifier

None.

ProcessState

DocSaProcessState

None.

SaleAmount

decimal number

None.

AppliedBalanceAmount

decimal number

None.

AmountToCollect

decimal number

None.

ControlVersion

Collection of byte

None.

Parts

Collection of VipSplitPaymentPartResponse

None.

InvoiceDocumentIds

Collection of globally unique identifier

None.

MaximumPayments

integer

None.

PaymentsAssigned

integer

None.

LastPaymentRequired

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "paymentGroupId": "a7711cc6-db4b-4976-823d-2964868e5a56",
  "activityId": "c85e4ea6-508c-4ef0-adbb-b855924ea4fa",
  "coordinatorDocumentId": "3797f557-1560-4837-bc3b-f7ddf06e4a66",
  "processState": 1,
  "saleAmount": 4.0,
  "appliedBalanceAmount": 5.0,
  "amountToCollect": 6.0,
  "controlVersion": "QEA=",
  "parts": [
    {
      "$id": "2",
      "documentId": "c5f2b3ed-ccb2-42f3-9007-86496005b091",
      "documentNumber": "sample string 2",
      "partNumber": 3,
      "partsCount": 4,
      "amount": 5.0,
      "partState": 1,
      "controlVersion": "QEA="
    },
    {
      "$ref": "2"
    }
  ],
  "invoiceDocumentIds": [
    "b8f8e13f-9b6b-4790-a8fe-795bfc766567",
    "c8d3b2b4-206a-4820-875e-e08e5469e176"
  ],
  "maximumPayments": 7,
  "paymentsAssigned": 8,
  "lastPaymentRequired": true
}