---
title: "Create a new Creditor Payment Control"
method: POST
path: "/creditor-agents/{ica}/payment-profiles/{creditor_profile_id}/payment-controls"
tags: ["Creditor Payment Controls"]
---

# Create a new Creditor Payment Control

`POST /creditor-agents/{ica}/payment-profiles/{creditor_profile_id}/payment-controls`

## Request

- Base URL: `https://api.mastercard.com/commercial/payments`
- URL: `https://api.mastercard.com/commercial/payments/creditor-agents/{ica}/payment-profiles/{creditor_profile_id}/payment-controls`
- Auth: none declared
- TypeScript: <https://skmtc.dev/mastercard/apis/payment-acceptance-api/docs/creditor-agents/:ica/payment-profiles/:creditor_profile_id/payment-controls/post.ts> (a function with typed inputs; its response is checked against the schema)

Create a new Creditor Payment Control.

## Path parameters

- `ica` string, required
- `creditor_profile_id` string, required

## Request body

- CreditorPaymentControlInformation: Creditor Payment Controls information.
  - `conditions` Conditions: The terms of the control.
    - `chargesInformation` PaymentControlChargesInformation
      - `flatAmount` string, nullable: A flat fee amount applied to the payment instruction.
      - `percentageAmount` string: A percentage fee amount applied to the payment instruction.
    - `instructedAmount` PaymentControlInstructedAmount
      - `max` string: Maximum amount allowed for this control
      - `min` string: Minimum amount allowed for this control
    - `referredDocumentInformation` PaymentControlReferredDocumentInformation[]: referredDocumentInformation
      - `time` Time, required
        - `maxDaysAfterRelatedDate` string: Calendar Days in UTC
      - `type` string, required: Specifies the type of referred document (ex. CINV - Commercial Invoice). Valid Values; CINV - Commercial Invoice
    - `relationship` Relationship: relationship
      - `excludeDebtors` ExcludeDebtors[]: Debtor's Tax ID(12345789) or Debtor's Debtor ID(Debtor.pay@stp)
        - `organisationIdentification` ExcludeOrganisationIdentification: Exclude Organisation Identification for the relationship.
          - `identification` string: Organisation Identification for the relationship.
          - `type` string: Organisation Identification Type for the relationship. Valid Values; TXID - Tax ID CUST - Customer Number PRID - Mastercard Profile ID
      - `includeDebtors` IncludeDebtors[]: Debtor relationships to be included with the control.
        - `organisationIdentification` IncludeOrganisationIdentification: Include Organisation Identification for the relationship.
          - `identification` string: Organisation Identification for the relationship.
          - `type` string: Organisation Identification Type for the relationship. Valid Values; TXID - Tax ID CUST - Customer Number PRID - Mastercard Profile ID
  - `decision` string, 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.
  - `paymentMethod` string, required: The payment rail applicable for the control. The control can be set against any payment method supported by the agent and Creditor.

## Response `201`

Creditor Payment Control information.

- CreditorPaymentControl
  - `conditions` Conditions: The terms of the control.
    - `chargesInformation` PaymentControlChargesInformation
      - `flatAmount` string, nullable: A flat fee amount applied to the payment instruction.
      - `percentageAmount` string: A percentage fee amount applied to the payment instruction.
    - `instructedAmount` PaymentControlInstructedAmount
      - `max` string: Maximum amount allowed for this control
      - `min` string: Minimum amount allowed for this control
    - `referredDocumentInformation` PaymentControlReferredDocumentInformation[]: referredDocumentInformation
      - `time` Time, required
        - `maxDaysAfterRelatedDate` string: Calendar Days in UTC
      - `type` string, required: Specifies the type of referred document (ex. CINV - Commercial Invoice). Valid Values; CINV - Commercial Invoice
    - `relationship` Relationship: relationship
      - `excludeDebtors` ExcludeDebtors[]: Debtor's Tax ID(12345789) or Debtor's Debtor ID(Debtor.pay@stp)
        - `organisationIdentification` ExcludeOrganisationIdentification: Exclude Organisation Identification for the relationship.
          - `identification` string: Organisation Identification for the relationship.
          - `type` string: Organisation Identification Type for the relationship. Valid Values; TXID - Tax ID CUST - Customer Number PRID - Mastercard Profile ID
      - `includeDebtors` IncludeDebtors[]: Debtor relationships to be included with the control.
        - `organisationIdentification` IncludeOrganisationIdentification: Include Organisation Identification for the relationship.
          - `identification` string: Organisation Identification for the relationship.
          - `type` string: Organisation Identification Type for the relationship. Valid Values; TXID - Tax ID CUST - Customer Number PRID - Mastercard Profile ID
  - `decision` string, 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.
  - `paymentControlId` string: A unique identifier for the Creditor payment control (UUID).
  - `paymentMethod` string, required: The payment rail applicable for the control. The control can be set against any payment method supported by the agent and Creditor.
  - `creditorId` string: CDP ID of Creditor receiving the payment. Examples: mastercard@stp and mastercard.northamerica@stp

## Other responses

- `400`: Bad request
- `404`: Not found

---

[API](https://skmtc.dev/mastercard/apis/payment-acceptance-api.md) - [All operations](https://skmtc.dev/mastercard/apis/payment-acceptance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mastercard/apis/payment-acceptance-api/revisions/baa0a0739572?raw)