GET /{merchantId}/profile/cid/{cid}

Path parameters

  • merchantId string Required

    Merchant identifier

  • cid string Required

    Customer identifier

    Maximum length is 36. Format should match the following pattern: ^[A-Za-z0-9\x2D]+$.

Responses

  • 200 application/json

    Request executed correctly

    Hide response attribute Show response attribute object
    • paymentProfiles array[object]

      List of card profiles

      Hide paymentProfiles attributes Show paymentProfiles attributes object

      Card profile data

      • id string(uuid)

        Payment profile identifier as 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

        Merchant identifier

      • merchantCustomerId string

        Customer identifier

      • firstName string

        Fisrt name of the payment card holder

      • lastName string

        Last name of the payment card holder

      • email string

        The payer's e-mail address in a format compliant with the RFC 5322 and RFC 6531 standards.

      • maskedNumber string

        Partially masked payment card number

      • month string

        Card validity - month

      • year string

        Card validity - year

      • organization string

        Payment card organisation

      • isActive integer

        Card profile activity status. 1 - active, 0 - inactive

        Values are 0 or 1.

      • profile string

        Card profile type

        Values are ONE_CLICK or RECURRING.

      • firstTransactionId string

        External identifier of the recording transaction. Required when debiting the card for OneClick and recurring payment without a profile.

GET /{merchantId}/profile/cid/{cid}
curl \
 --request GET 'https://api.imoje.pl/v1/merchant/{merchantId}/profile/cid/{cid}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "paymentProfiles": [
    {
      "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"
    }
  ]
}