Retrieving profile information based on profile ID Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://bump.sh/pgw/doc/imoje-api-en/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
"imoje API eng MCP server": {
  "url": "https://bump.sh/pgw/doc/imoje-api-en/mcp"
}
Close
GET /{merchantId}/profile/id/{paymentProfileId}
Authorization token

Path parameters

  • merchantId string Required

    Merchant identifier

  • paymentProfileId string(uuid) Required

    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}$.

Responses

  • 200 application/json

    Request executed correctly

    Hide response attributes Show response attributes object
    • paymentProfile object

      Card profile data

      Hide paymentProfile attributes Show paymentProfile attributes object
      • 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.

      • * string | integer | number | boolean | object | array Additional properties

        Additional parameters that are not described and may appear in the response as part of API development.

        Your API response validation scheme should always allow new parameters.

    • * string | integer | number | boolean | object | array Additional properties

      Additional parameters that are not described and may appear in the response as part of API development.

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