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

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
RefundDocumentId	globally unique identifier	None.
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": "4a402118-e6bd-48d9-ae88-5aba1e6f26a7",
  "paymentOwnerToken": "2acc8942-1f45-47b4-a8ba-f94ace927b36",
  "sourceDocumentId": "2b77b8d0-07d9-4f3c-8abf-99dd8794a8ff",
  "sourcePaymentLine": 4,
  "refundDocumentId": "babea7bc-2cda-4877-a975-5604356d012c",
  "refundOperationId": "96d8f411-3455-45d5-a6a2-2aba332a85e0",
  "coordinatorControlVersion": "QEA=",
  "sourceControlVersion": "QEA="
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VipSplitProcessResponse

Name	Type	Additional 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": "5b047dea-83b5-40b8-a75f-283a8d15ab84",
  "activityId": "3624e6dc-6f35-4652-84ac-3e23b273673a",
  "coordinatorDocumentId": "77c2c148-748f-4901-b70a-accedeb630a0",
  "processState": 1,
  "saleAmount": 4.0,
  "appliedBalanceAmount": 5.0,
  "amountToCollect": 6.0,
  "controlVersion": "QEA=",
  "parts": [
    {
      "$id": "2",
      "documentId": "0100c089-22dc-4cbc-9f00-eaf3da022e04",
      "documentNumber": "sample string 2",
      "partNumber": 3,
      "partsCount": 4,
      "amount": 5.0,
      "partState": 1,
      "controlVersion": "QEA="
    },
    {
      "$ref": "2"
    }
  ],
  "invoiceDocumentIds": [
    "4d9a785e-7213-46da-b355-1298bc011f05",
    "de42f375-1095-4948-a2de-5b8ecaecdfda"
  ],
  "maximumPayments": 7,
  "paymentsAssigned": 8,
  "lastPaymentRequired": true
}