MAmastercard
CreditorRegistration

Retrieve a Creditor Registration

This endpoint allows you to retrieve a Creditor by its identification.

get/creditor-agents/{ica}/creditors/{creditor_id}

Request

Path parameters

icastring required

Interbank Card Association ID

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

Registration ID of the Creditor (UUID).

Response

Details of registered Creditor.

dbastring

Doing Business As

idstring

A unique identifier for the Creditor's Company generated by system (UUID).

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

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

Example response

{
  "dba": "Creditor Co.",
  "id": "489eca17-6504-42ec-aaf8-b59ca9fdf9d5",
  "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"
    }
  ]
}

Changes

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