MAmastercard
Creditor Payment Controls

Get All Creditor Payment Controls

Get All Creditor Payment Controls.

get/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.

Response

List of creditor payment controls information.

Example response

{
  "paymentControls": [
    {
      "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.