POST api/tt_doc_sa/vip-split/external/payment/confirm

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
pos_name	string	Required String length: inclusive between 0 and 50
id_rua	globally unique identifier	None.
terminal_name	string	Required String length: inclusive between 0 and 10
payment_group_id	globally unique identifier	None.
document_id	globally unique identifier	None.
payment_operation_id	globally unique identifier	None.
payment_mode	VipSplitPaymentMode	None.
amount	decimal number	None.
cash_received_amount	decimal number	None.
terminal_response	socket_event_transaction_response_api	None.
coordinator_control_version	Collection of byte	Required Max length: 8 Min length: 8
part_control_version	Collection of byte	Required Max length: 8 Min length: 8

Request Formats

application/json, text/json

Sample:

{
  "pos_name": "sample string 1",
  "id_rua": "cba8b2ba-c03a-4f87-85b9-e49a8bb7333c",
  "terminal_name": "sample string 3",
  "payment_group_id": "70de279c-f69e-4154-9d9c-b9fa1277a833",
  "document_id": "01be2f0e-a5df-497e-a751-8c210a1239cd",
  "payment_operation_id": "e5f9018f-45b4-4295-b10f-65c8efbcc1c6",
  "payment_mode": 1,
  "amount": 7.0,
  "cash_received_amount": 1.0,
  "terminal_response": {
    "$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"
    }
  },
  "coordinator_control_version": "QEA=",
  "part_control_version": "QEA="
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VipSplitExternalPaymentConfirmResponse

Name	Type	Additional information
PaymentConfirmed	boolean	None.
InvoiceGenerated	boolean	None.
FinalizationPending	boolean	None.
Code	string	None.
Message	string	None.
Process	VipSplitProcessResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "paymentConfirmed": true,
  "invoiceGenerated": true,
  "finalizationPending": true,
  "code": "sample string 4",
  "message": "sample string 5",
  "process": {
    "$id": "2",
    "paymentGroupId": "6c5f1dcd-7433-4814-99ce-1a5222072874",
    "activityId": "5454bac2-52fb-4c42-855e-2972252ad30c",
    "coordinatorDocumentId": "770f56d5-19d3-427d-918a-f9b0f1c4a2cb",
    "processState": 1,
    "saleAmount": 4.0,
    "appliedBalanceAmount": 5.0,
    "amountToCollect": 6.0,
    "controlVersion": "QEA=",
    "parts": [
      {
        "$id": "3",
        "documentId": "a2c38194-2751-4f96-b6e8-99c20c747215",
        "documentNumber": "sample string 2",
        "partNumber": 3,
        "partsCount": 4,
        "amount": 5.0,
        "partState": 1,
        "controlVersion": "QEA="
      },
      {
        "$ref": "3"
      }
    ],
    "invoiceDocumentIds": [
      "1e67ecd9-f607-4f21-9236-13314455fd6a",
      "9e6587e4-3fec-4500-a724-ee0e341fc9c5"
    ]
  }
}