CreditorRegistration

Register a creditor

This endpoint allows you to register a new Creditor in the Supplier Directory.

post/creditor-agents/{ica}/creditors

Request

Base URL
https://api.mastercard.com/commercial/payments
Auth
none declared
TypeScript
https://skmtc.dev/mastercard/apis/payment-acceptance-api/docs/creditor-agents/:ica/creditors/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

icastring required

Interbank Card Association ID

Request body

dbastring

Doing Business As

inactiveReasonstring

Identifies the reason why the business is not active in CDP. Valid Values 'PRE_REGISTERED', 'AGENT_HOLD'

isActiveboolean

Indicates if the business is active in CDP.

legalBusinessNamestring required

Identifies the legal business name of the Creditor receiving the payment.

Example request

{
  "dba": "Creditor Co.",
  "inactiveReason": "PRE_REGISTERED",
  "isActive": true,
  "legalBusinessAddress": {
    "addressLine": "2200 Mastercard Blvd.",
    "country": "US",
    "countrySubDivision": "MO",
    "postCode": "63368",
    "townName": "O'Fallon"
  },
  "legalBusinessName": "Creditor Company",
  "organisationIdentifications": [
    {
      "identification": "998765432",
      "type": "TXID"
    }
  ],
  "paymentProfiles": [
    {
      "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

A unique ID for each result.

idstring

A unique ID generated for each result.

Example response

{
  "id": "489eca17-6504-42ec-aaf8-b59ca9fdf9d5"
}

Changes

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