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

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.
payment_amount	decimal number	None.
coordinator_control_version	Collection of byte	Required Max length: 8 Min length: 8
part_control_version	Collection of byte	Max length: 8 Min length: 8

Request Formats

application/json, text/json

Sample:

{
  "pos_name": "sample string 1",
  "id_rua": "0b93bd95-f1ee-4928-9de4-fc05af85b6fd",
  "terminal_name": "sample string 3",
  "payment_group_id": "eb78cf86-ba43-4ee1-a458-1ff48fa2ed8e",
  "document_id": "ec23fa32-358d-49b5-b83b-73289b259683",
  "payment_operation_id": "d7cfb3cb-261b-4d24-831f-8664412c5924",
  "payment_mode": 1,
  "payment_amount": 1.0,
  "coordinator_control_version": "QEA=",
  "part_control_version": "QEA="
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VipSplitPaymentStartResponse

Name	Type	Additional information
DocumentId	globally unique identifier	None.
PaymentOperationId	globally unique identifier	None.
PaymentMode	VipSplitPaymentMode	None.
Amount	decimal number	None.
IsNewOperation	boolean	None.
Process	VipSplitProcessResponse	None.
TerminalName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "documentId": "569e6456-1702-429a-942a-445a03cfe6b9",
  "paymentOperationId": "ed7ae17a-f905-4e2d-a32d-90f94c89d222",
  "paymentMode": 1,
  "amount": 3.0,
  "isNewOperation": true,
  "process": {
    "$id": "2",
    "paymentGroupId": "e53c1fa3-63ee-46a4-809f-2b16326f28a6",
    "activityId": "7c3004fb-f344-4a68-b77e-0aa28a80f2d0",
    "coordinatorDocumentId": "3c1eb23b-e33c-4550-b83c-5abaa9354c82",
    "processState": 1,
    "saleAmount": 4.0,
    "appliedBalanceAmount": 5.0,
    "amountToCollect": 6.0,
    "controlVersion": "QEA=",
    "parts": [
      {
        "$id": "3",
        "documentId": "08221d5c-aca0-413c-bc35-500d1fe9216b",
        "documentNumber": "sample string 2",
        "partNumber": 3,
        "partsCount": 4,
        "amount": 5.0,
        "partState": 1,
        "controlVersion": "QEA="
      },
      {
        "$ref": "3"
      }
    ],
    "invoiceDocumentIds": [
      "71167eb4-1b11-4fbb-83d1-56d7e94506d6",
      "ac810ace-0eff-4798-ab4b-43349e8c6846"
    ],
    "maximumPayments": 7,
    "paymentsAssigned": 8,
    "lastPaymentRequired": true
  },
  "terminalName": "sample string 5"
}