MAmastercard
Creditor Payment Controls

Create a new Creditor Payment Control

Create a new Creditor Payment Control.

post/creditor-agents/{ica}/payment-profiles/{creditor_profile_id}/payment-controls

Request

Path parameters

icastring required

Interbank Card Association ID

creditor_profile_idstring required
Example:matest.creditor5@stp

A unique ID created by the Creditor Agent to identify the Creditor profile.

Request body

decisionstring required

The desired outcome when a payment instruction violates a Creditor's payment controls.There are two valid values, WARNING and REJECT. Warning: Use WARNING to notify all associated payment agents that the payment instruction violates your Creditor's controls. The payment instruction proceeds through the payment lifecycle. You receive the payment instruction warning and APPROVE or REJECT as necessary.

Reject: Use REJECT to notify the Debtor Agent that the payment instruction violates the Creditor's controls and does not proceed through the payment lifecycle. CDP rejects the payment instruction and provides a rejection reason code and description to the Debtor Agent.

paymentMethodstring required

The payment rail applicable for the control. The control can be set against any payment method supported by the agent and Creditor.

Example request

{
  "conditions": {
    "chargesInformation": {
      "flatAmount": "20.0",
      "percentageAmount": "2.5"
    },
    "instructedAmount": {
      "max": "5000.2",
      "min": "50.99"
    },
    "referredDocumentInformation": [
      {
        "time": {
          "maxDaysAfterRelatedDate": "10"
        },
        "type": "CINV"
      }
    ],
    "relationship": {
      "excludeDebtors": [
        {
          "organisationIdentification": {
            "identification": "12-3456789",
            "type": "TXID"
          }
        }
      ],
      "includeDebtors": [
        {
          "organisationIdentification": {
            "identification": "12345789",
            "type": "TXID"
          }
        }
      ]
    }
  },
  "decision": "REJECT",
  "paymentMethod": "CARD"
}

Response

Creditor Payment Control information.

decisionstring required

The desired outcome when a payment instruction violates a Creditor's payment controls. There are two valid values, WARNING and REJECT. Warning: Use WARNING to notify all associated payment agents that the payment instruction violates your Creditor's controls. The payment instruction proceeds through the payment lifecycle. You receive the payment instruction warning and APPROVE or REJECT as necessary.

Reject: Use REJECT to notify the Debtor Agent that the payment instruction violates the Creditor's controls and does not proceed through the payment lifecycle. CDP rejects the payment instruction and provides a rejection reason code and description to the Debtor Agent.

paymentControlIdstring

A unique identifier for the Creditor payment control (UUID).

paymentMethodstring required

The payment rail applicable for the control. The control can be set against any payment method supported by the agent and Creditor.

creditorIdstring

CDP ID of Creditor receiving the payment. Examples: mastercard@stp and mastercard.northamerica@stp

Example response

{
  "conditions": {
    "chargesInformation": {
      "flatAmount": "20.0",
      "percentageAmount": "2.5"
    },
    "instructedAmount": {
      "max": "5000.2",
      "min": "50.99"
    },
    "referredDocumentInformation": [
      {
        "time": {
          "maxDaysAfterRelatedDate": "10"
        },
        "type": "CINV"
      }
    ],
    "relationship": {
      "excludeDebtors": [
        {
          "organisationIdentification": {
            "identification": "12-3456789",
            "type": "TXID"
          }
        }
      ],
      "includeDebtors": [
        {
          "organisationIdentification": {
            "identification": "12345789",
            "type": "TXID"
          }
        }
      ]
    }
  },
  "decision": "REJECT",
  "paymentControlId": "489eca17-6504-42ec-aaf8-b59ca9fdf9d5",
  "paymentMethod": "CARD",
  "creditorId": "matest.creditor1@stp"
}

Changes

No recorded changes to this operation across all 1 revision of this API.