Read Payment Moral

The ReadPaymentMoral API in OCS.io is designed to retrieve the payment moral of a specific account.

API Overview

Parameters Required for Reading Payment Moral

The following table lists and describes the parameters required to read the payment moral through the ReadPaymentMoral API:

Parameter Description

refId

Ref ID of the Account

externalId

External ID of the Account

calculationForced

Indicates whether Payment Moral calculation is forced.
Detailed API documentation and endpoint specifics are available here.

Request Validations

The following validations are performed when reading the payment moral:

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

Read Payment Moral Example

Here is a cURL example for the ReadPaymentMoral API:

curl -X GET 'https://api.ocs.io/v1/rm/payer/read-payment-moral?externalId=<account_external_id>&calculationForced=true'

The outcome of the API call is as follows:

  • The payment moral of the account with external ID <account_external_id> is retrieved.

  • If calculationForced is set to true, the payment moral calculation is forced.