MAmastercard
CreditorRegistration

Retrieve All Creditor Registrations

This endpoint allows you to retrieve all existing Creditors.

get/creditor-agents/{ica}/creditors

Request

Path parameters

icastring required

Interbank Card Association ID

Query parameters

legal_business_namestring

Legal business name of the creditor.

dbastring

Doing Business As

creditor_profile_idstring

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.

is_activeboolean

Indicates if the business is active in CDP.

offsetinteger

Offset is the start of the paginated records to be fetched.

limitinteger

The limit is the paginated number of records to be fetched.

sort'ORGANISATION_NAME' | 'ADDRESS_LINE' | 'TOWN_NAME' | 'COUNTRY_SUB_DIVISION' | 'POST_CODE' | 'COUNTRY_CODE' | 'ORGANISATION_IDENTIFICATION' | 'PROFILE_COUNT'

Sort by fields (add +/- to the front for ascending/descending)

Response

List of Creditor Search result.

Example response

{
  "data": {
    "count": 1,
    "items": [
      {
        "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"
          }
        ],
        "profileCount": 22
      }
    ],
    "limit": 25,
    "total": 1
  }
}

Changes

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