MAmastercard
CreditorProfiles

Create a Creditor Profile

This endpoint allows you to create a Creditor profile.

post/creditor-agents/{ica}/creditors/{creditor_id}/payment-profiles

Request

Path parameters

icastring required

Interbank Card Association ID

creditor_idstring required
Example:489eca17-6504-42ec-aaf8-b59ca9fdf9d5

Registration ID of the Creditor (UUID).

Request body

isActiveboolean

Indicates if the profile is active in CDP.

emailstring email

Business-only email of profile (not personal).

paymentMethodsstring[] required

Identifies the supported payment methods. Specifies the form of payment that will be used to complete the transaction. Valid values: CARD

creditorProfileIdstring required

Payment profile identifier, Format must be either: '<creditor>@stp' or '<creditor>.<branch>@stp'. Follow below format specifications - <creditor> is limited to 25 characters (no special characters) <branch> is optional and limited to 25 characters (no special characters) '@stp' is required not case sensitive.

paymentProcessorstring

ICA of the payment processor.

Example request

{
  "isActive": true,
  "email": "creditor@yourcompany.com",
  "gatewayIdentification": {
    "merchantId": "US123456A12",
    "terminalIds": [
      "TER0113Y"
    ],
    "gatewayName": "Mastercard Gateway",
    "bankMerchantId": "MERCHANT123456AA",
    "acquirerBank": "Network International via S2I",
    "acquirerId": "CISTEST_S2I",
    "cardBrands": [
      "MASTERCARD",
      "VISA"
    ],
    "currencies": [
      "USD",
      "EUR"
    ],
    "pennyTxnTokenRefId": "489eca17-6504-42ec-aaf8-b59ca9fdf9d5",
    "attributes": [
      "url: https://ghvfhcvb",
      "region: mpgs-nam",
      "categoryCode: 1234",
      "timeZone: America/New_York",
      "goodsDescription: Electronics",
      "visaMerchantVerificationValue: 221B12345A",
      "serviceProviderMerchantId: ABC123456789"
    ]
  },
  "payToAddress": {
    "addressLine": "2200 Mastercard Blvd.",
    "country": "US",
    "countrySubDivision": "MO",
    "postCode": "63368",
    "townName": "O'Fallon"
  },
  "paymentMethods": [
    "CARD"
  ],
  "creditorProfileId": "matest.creditor5@stp",
  "paymentProcessor": "12345"
}

Response

Success

Changes

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