Cancel Incoming Payment Identification

The CancelPaymentInIdentification API is used to cancel the identification of incoming payments from an account in OCS.io. This API is particularly useful when there’s a need to record the cancellation of payment identifications.

API Overview

Fields Required for Cancelling Payment Identification

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

Field	Description
account	ID (Ref ID/ External ID ) of the Account.
paymentRefId	ID (Ref ID) of the Incoming Payment.
reason	Reason for Cancellation.

Field

Description

account

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

paymentRefId

ID (Ref ID) of the Incoming Payment.

reason

Reason for Cancellation.

Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when cancelling an incoming payment identification:

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.
Incoming Payment provided in the request, must exist in the system.
Cancellation Reason must be configured in the system.

Cancel Payment Identification Example

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

{
  "requestId": "{{$guid}}",
  "user": "crm",
  "account": {
    "externalId": "account_external_id"
  },
  "paymentRefId": "payment_ref_id",
  "reason": "cancellation_reason"
}

The outcome of the API call is as follows:

The payment identification with reference ID payment_ref_id is cancelled.
The reason for cancellation is cancellation_reason.