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

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PaymentGroupId	globally unique identifier	None.
PaymentOwnerToken	globally unique identifier	None.
DocumentId	globally unique identifier	None.
PaymentOperationId	globally unique identifier	None.
PaymentMode	VipSplitPaymentMode	None.
CoordinatorControlVersion	Collection of byte	Required Max length: 8 Min length: 8
PartControlVersion	Collection of byte	Max length: 8 Min length: 8
TerminalName	string	Max length: 10
PaymentAmount	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "paymentGroupId": "320ccf44-4013-408f-abcb-076391761601",
  "paymentOwnerToken": "8d778f29-a626-48e0-9193-26cf310556cd",
  "documentId": "b8ffe0bc-c17f-4133-856a-042def51c121",
  "paymentOperationId": "6dc98d01-5aef-406c-9743-76933b1b6c8f",
  "paymentMode": 1,
  "coordinatorControlVersion": "QEA=",
  "partControlVersion": "QEA=",
  "terminalName": "sample string 5",
  "paymentAmount": 1.0
}

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": "198bbd2f-0c48-480f-a07a-9140bc597190",
  "paymentOperationId": "ae5babaf-f4a8-4108-adde-60c1b3e7cf9e",
  "paymentMode": 1,
  "amount": 3.0,
  "isNewOperation": true,
  "process": {
    "$id": "2",
    "paymentGroupId": "8bc4a8ce-7dbd-493e-a6b2-594ee4890fae",
    "activityId": "f5a7cc8f-5056-47f1-9c63-1998b59f97fc",
    "coordinatorDocumentId": "45c8a300-a734-4cd9-b6b3-fa2d136ec54b",
    "processState": 1,
    "saleAmount": 4.0,
    "appliedBalanceAmount": 5.0,
    "amountToCollect": 6.0,
    "controlVersion": "QEA=",
    "parts": [
      {
        "$id": "3",
        "documentId": "9e3a0a01-abe6-4906-95db-ee2d2340e3f6",
        "documentNumber": "sample string 2",
        "partNumber": 3,
        "partsCount": 4,
        "amount": 5.0,
        "partState": 1,
        "controlVersion": "QEA="
      },
      {
        "$ref": "3"
      }
    ],
    "invoiceDocumentIds": [
      "c4fff4af-8f9e-4797-9e4b-cc9797e93c66",
      "c0dba13c-f095-4a43-89eb-d7b905453c2a"
    ],
    "maximumPayments": 7,
    "paymentsAssigned": 8,
    "lastPaymentRequired": true
  },
  "terminalName": "sample string 5"
}