Identify Incoming Payment

The IdentifyPaymentIn API is used to set incoming payments as identified to an account in OCS.io. This API is particularly useful when there’s a need to record the identification of incoming payments.

API Overview

Fields Required for Identifying Incoming Payment

The following table lists and describes the fields required to identify an incoming payment through the IdentifyPaymentIn API:

Field Description

account

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

paymentRefId

ID (Ref ID) of the Incoming Payment.

notificationRequested

Indicates whether 'Payment Received' Notification will be triggered.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when identifying an incoming payment:

  • 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.

Identify Incoming Payment Example

Use the following request’s body to identify an incoming payment:

{
  "requestId": "{{$guid}}",
  "user": "crm",
  "account": {
    "externalId": "account_external_id"
  },
  "paymentRefId": "payment_ref_id",
  "notificationRequested": true
}

The outcome of the API call is as follows:

  • The incoming payment is identified with the specified details.

  • A 'Payment Received' notification is triggered if notificationRequested is set to true.