PUT api/receipt/paymentitem?negotiatorId={negotiatorId}&manualProcess={manualProcess}

Process payment items Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
negotiatorId

The unique identifier of the negotiator resource.

integer

Required

manualProcess

The manual process value supplied with the request.

boolean

Required

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

ProcessPaymentItemResponseDataContract
NameDescriptionTypeAdditional information
Payments

The collection of payments.

Collection of integer

None.

PaymentStatementPreviewReziDocumentRefs

The collection of payment statement preview rezi document refs.

Collection of string

None.

FailedPaymentItems

The collection of failed payment items.

Collection of FailedPaymentItemDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "Payments": [
    1,
    2
  ],
  "PaymentStatementPreviewReziDocumentRefs": [
    "sample string 1",
    "sample string 2"
  ],
  "FailedPaymentItems": [
    {
      "PaymentItemId": 1,
      "Message": "sample string 2"
    },
    {
      "PaymentItemId": 1,
      "Message": "sample string 2"
    }
  ]
}