MAmastercard
Debtors

Retrieve Debtor Details

This endpoint returns information of a Debtor.

get/debtors/{debtor_profile_id}

Request

Path parameters

debtor_profile_idstring required

A unique ID created by the Debtor Agent to identify the Debtor profile.

Response

Details of Debtor.

debtorProfileIdstring

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

namestring

Identifies the legal business name of the Debtor making the payment (UUID).

registrationIdstring required

Unique identifier of Debtor.

statusstring

A flag for the Debtor's status in the CDP.

taxIdstring

Tax identifier of the Debtor making the payment.

paymentMethodsstring[] required

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

Example response

{
  "address": {
    "addressLine": "2200 Mastercard Blvd.",
    "country": "US",
    "countrySubDivision": "MO",
    "postCode": "63368",
    "townName": "O'Fallon"
  },
  "debtorProfileId": "matest.debtor1.pay@stp",
  "name": "MA Test Debtor 1",
  "registrationId": "7b8bfb09-3fdc-4cd1-b768-477757fec6be",
  "status": "ACTIVE",
  "taxId": "123456789",
  "paymentMethods": [
    "CARD"
  ],
  "organisationIdentifications": [
    {
      "identification": "998765432",
      "type": "TXID"
    }
  ]
}

Changes

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