Cancel Incoming Payment Assignment

The CancelPaymentInAssignment API is used to cancel assignments between identified incoming payments and documents in OCS.io. This API is particularly useful when there’s a need to record the cancellation of payment assignments.

API Overview

Fields Required for Cancelling Payment Assignment

The following table lists and describes the fields required to cancel a payment assignment through the CancelPaymentInAssignment API:

Field	Description
account	ID (Ref ID/ External ID ) of the Account.
monetaryTransactionRefId	ID (Ref ID) of the Monetary Transaction.
reason	Reason for Cancellation.

Field

Description

account

ID (Ref ID/ External ID ) of the Account.

monetaryTransactionRefId

ID (Ref ID) of the Monetary Transaction.

reason

Reason for Cancellation.

Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when cancelling a payment assignment:

Account must be provided in the request, it must be already created in the system and must not be in Deactivated State.
Payer must be already created in the system.
Monetary Transaction must exist in the system.
Cancellation Reason Incoming Payment to Outgoing Payment must be configured in the system.

Cancel Payment Assignment Example

Use the following request’s body to cancel a payment assignment:

{
  "requestId": "{{$guid}}",
  "user": "crm",
  "account": {
    "externalId": "account_external_id"
  },
  "monetaryTransactionRefId": "monetary_transaction_ref_id",
  "reason": "cancellation_reason"
}

The outcome of the API call is as follows:

The payment assignment with reference ID monetary_transaction_ref_id is cancelled.
The reason for cancellation is cancellation_reason.