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

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PaymentGroupId	globally unique identifier	None.
PaymentOwnerToken	globally unique identifier	None.
SourceDocumentId	globally unique identifier	None.
SourcePaymentLine	integer	Range: inclusive between 1 and 2147483647
RefundOperationId	globally unique identifier	None.
CoordinatorControlVersion	Collection of byte	Required Max length: 8 Min length: 8
SourceControlVersion	Collection of byte	Required Max length: 8 Min length: 8

Request Formats

application/json, text/json

Sample:

{
  "paymentGroupId": "06206ab3-e2f6-4c19-8d74-95f6c730efb6",
  "paymentOwnerToken": "f905d15b-6453-48a6-a94e-1607e1054e66",
  "sourceDocumentId": "425f6797-a867-42c5-9faf-94a6fe487920",
  "sourcePaymentLine": 4,
  "refundOperationId": "290c167c-60f5-4f73-9e0c-cec5cb896af9",
  "coordinatorControlVersion": "QEA=",
  "sourceControlVersion": "QEA="
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VipSplitRefundStartResponse

Name	Type	Additional information
SourceDocumentId	globally unique identifier	None.
SourcePaymentLine	integer	None.
RefundDocumentId	globally unique identifier	None.
RefundOperationId	globally unique identifier	None.
PaymentMode	VipSplitPaymentMode	None.
TerminalName	string	None.
Amount	decimal number	None.
CurrencyCode	string	None.
OriginalTransactionId	string	None.
IsNewOperation	boolean	None.
SourceControlVersion	Collection of byte	None.
Process	VipSplitProcessResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "sourceDocumentId": "c6759b1c-de19-42c0-a7d0-d1b4738f284f",
  "sourcePaymentLine": 2,
  "refundDocumentId": "3d357cbe-51b0-4c1b-b27e-627e6c8e4372",
  "refundOperationId": "de1e43f2-b99d-48a8-b171-291333b09c5f",
  "paymentMode": 1,
  "terminalName": "sample string 5",
  "amount": 6.0,
  "currencyCode": "sample string 7",
  "originalTransactionId": "sample string 8",
  "isNewOperation": true,
  "sourceControlVersion": "QEA=",
  "process": {
    "$id": "2",
    "paymentGroupId": "3444396e-2428-4969-b99d-f2366e9c2d6b",
    "activityId": "b4076c90-c11b-46ff-b3bc-26fb0dea1afb",
    "coordinatorDocumentId": "53f70d16-b196-4d60-bd1d-794b9f8cf239",
    "processState": 1,
    "saleAmount": 4.0,
    "appliedBalanceAmount": 5.0,
    "amountToCollect": 6.0,
    "controlVersion": "QEA=",
    "parts": [
      {
        "$id": "3",
        "documentId": "ff53195e-5cf7-4dad-86fb-39665611f2f6",
        "documentNumber": "sample string 2",
        "partNumber": 3,
        "partsCount": 4,
        "amount": 5.0,
        "partState": 1,
        "controlVersion": "QEA="
      },
      {
        "$ref": "3"
      }
    ],
    "invoiceDocumentIds": [
      "4835f624-f9fb-477a-ac89-549173acb850",
      "73d4625c-3a57-4c9f-b15a-099db0a35e4c"
    ],
    "maximumPayments": 7,
    "paymentsAssigned": 8,
    "lastPaymentRequired": true
  }
}