Pobranie informacji o profilu na podstawie identyfikatora profilu Run in API Explorer

GET /{merchantId}/profile/id/{paymentProfileId}

Path parameters

  • merchantId string Required

    Identyfikator klienta

  • paymentProfileId string(uuid) Required

    Identyfikator profilu jako UUID v4

    Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

Responses

  • 200 application/json

    Zapytanie wykonane poprawnie

    Hide response attribute Show response attribute object
    • paymentProfile object

      Dane profilu kartowego

      Hide paymentProfile attributes Show paymentProfile attributes object
      • id string(uuid)

        Identyfikator profilu jako UUID v4

        Maximum length is 36. Format should match the following pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$.

      • merchantMid string

        Identyfikator klienta

      • merchantCustomerId string

        Identyfikator płatnika

      • firstName string

        Imię płatnika

      • lastName string

        Nazwisko płatnika

      • email string

        Adres e-mail płatnika w formacie zgodnym ze standardem RFC 5322 oraz RFC 6531.

      • maskedNumber string

        Częściowo zamaskowany numer karty płatnika

      • month string

        Ważność karty płatniczej - miesiąc

      • year string

        Ważność karty płatniczej - rok

      • organization string

        Organizacja karty płatniczej

      • isActive integer

        Status aktywności profilu kartowego. 1 - aktywny, 0 - nieaktywny

        Values are 0 or 1.

      • profile string

        Typ profilu kartowego.

        Values are ONE_CLICK or RECURRING.

      • firstTransactionId string

        Zewnętrzny identyfikator transakcji rejestrującej. Wymagany przy obciążaniu karty w płatnościach OneClick i rekurencyjnej bez profilu.

GET /{merchantId}/profile/id/{paymentProfileId}
curl \
 --request GET 'https://sandbox.api.imoje.pl/v1/merchant/{merchantId}/profile/id/{paymentProfileId}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "paymentProfile": {
    "id": "46f095b4-be6f-4ea0-8052-475ac8fbf218",
    "year": "2029",
    "email": "john.doe@example.com",
    "month": "12",
    "profile": "ONE_CLICK",
    "isActive": 1,
    "lastName": "Doe",
    "firstName": "John",
    "merchantMid": "rgfnb43ub57pry2nuc13",
    "maskedNumber": "****1111",
    "organization": "MASTERCARD",
    "firstTransactionId": "MCC1111111111",
    "merchantCustomerId": "yourMerchantCustomerId"
  }
}