# Retrieve list of BLIK aliases

Endpoint: GET /payment/{serviceId}/blik/aliases
Version: 1.0.0
Security: bearerAuth

## Path parameters:

  - `serviceId` (string, required)
    Service ID

## Query parameters:

  - `filter[status]` (string)
    BLIK alias status
    Enum: "alias_pending_registration", "alias_active", "alias_expired", "alias_unregistered"

  - `filter[type]` (string)
    BLIK alias type
    Enum: "PAYID", "UID"

  - `filter[uuid]` (string)
    Alias ID
    Example: "019970c6-3ce8-71e7-8214-20fd635532fb"

  - `filter[value]` (string)
    BLIK alias value
    Example: "AABBCC"

  - `page` (integer)
    Page number
    Example: 1

  - `perPage` (integer)
    Number of results per page
    Example: 20

  - `sort` (string)
    Sort order (-created_at = newest first, created_at = oldest first)
    Enum: "-created_at", "created_at"

## Response 200 fields (application/json):

  - `success` (boolean, required)
    Request status
    Example: true

  - `data` (array, required)
    Example: [{"id":"019970c6-3ce8-71e7-8214-20fd635532fb","type":"PAYID","value":"AABBCC","label":"Payment for premium package","blik_key":null,"status":"alias_active","expires_at":"2035-07-15T00:00:00+02:00","created_at":"2025-09-22T11:34:23+02:00","updated_at":"2025-09-22T11:34:32+02:00","subscription":{"id":"019970c6-3d3e-708c-9313-5f89e251e2c0","status":"subscription_active","mode":"BLIK","blik":{"model":"O"},"frequency":null,"initiation_date":null,"total_amount_limit":null,"total_transactions_limit":null,"cancelled":null,"created_at":"2025-09-22T11:34:24+02:00","updated_at":"2025-09-22T11:34:32+02:00"}},{"id":"0198a54d-05d9-7177-9ac6-5d9831bc988d","type":"PAYID","value":"CCBBAA","label":"Music subscription","blik_key":null,"status":"alias_unregistered","expires_at":null,"created_at":"2025-08-13T23:19:05+02:00","updated_at":"2025-08-13T23:19:16+02:00","subscription":{"id":"0198a54d-05e1-72b8-b835-f2258609bb52","status":"subscription_cancelled","mode":"BLIK","blik":{"model":"O"},"frequency":"1M","initiation_date":"2025-08-13T23:15:13+02:00","total_amount_limit":null,"total_transactions_limit":null,"cancelled":{"by":"merchant","reason":"User cancellation"},"created_at":"2025-08-13T23:19:05+02:00","updated_at":"2025-08-13T23:19:16+02:00"}}]

  - `data.id` (string, required)
    Alias ID

  - `data.type` (string, required)
    BLIK alias type
    Enum: "PAYID", "UID"

  - `data.value` (string, required)
    Alias value
    Example: "AABBCC"

  - `data.label` (string, required)
    Label displayed in the mobile app
    Example: "Payment for a premium package on service aaa"

  - `data.blik_key` (string,null)
    Alias identifier in BLIK (for a PAYID alias this will be empty)

  - `data.status` (string, required)
    BLIK alias status
    Enum: "alias_pending_registration", "alias_active", "alias_expired", "alias_unregistered"

  - `data.expires_at` (string)
    Creation date in format: ISO 8601

  - `data.created_at` (string, required)
    Creation date in format: ISO 8601

  - `data.updated_at` (string, required)
    Creation date in format: ISO 8601

  - `data.subscription` (object)

  - `data.subscription.id` (string, required)
    Subscription ID

  - `data.subscription.status` (string, required)
    Subscription status
    Enum: "subscription_pending", "subscription_active", "subscription_cancelled", "subscription_expired", "subscription_finished", "subscription_fraudulent"

  - `data.subscription.mode` (string, required)
    Subscription mode
    Enum: "BLIK", "CARD"

  - `data.subscription.blik` (object)

  - `data.subscription.blik.model` (string, required)
    BLIK Recurrent Payment Model
    Enum: "A", "O", "M"

  - `data.subscription.frequency` (string,null)
    Subscription frequency
    Example: "1M"

  - `data.subscription.initiation_date` (string,null)
    Date of the first possible Recurring Payment
    Example: "2025-08-13T23:15:13+02:00"

  - `data.subscription.total_amount_limit` (number,null)
    Total amount limit for this Recurring Payment
    Example: 4000

  - `data.subscription.total_transactions_limit` (integer,null)
    Total number of possible transactions for this Recurring Payment
    Example: 12

  - `data.subscription.cancelled` (object,null)

  - `data.subscription.cancelled.by` (string, required)
    Subscription cancelled by
    Enum: "system", "antifraud", "merchant", "payer", "blik"

  - `data.subscription.cancelled.reason` (string,null)
    Reason for subscription cancellation

  - `pagination` (object, required)

  - `pagination.total` (integer, required)
    Total number of records
    Example: 1

  - `pagination.count` (integer, required)
    Number of records on the current page
    Example: 1

  - `pagination.per_page` (integer, required)
    Maximum number of records per page
    Example: 15

  - `pagination.current_page` (integer, required)
    Current page
    Example: 1

  - `pagination.total_pages` (integer, required)
    Total number of pages
    Example: 1

  - `pagination.links` (object, required)
    URLs to pages

  - `pagination.links.next_page` (string,null, required)
    URL to the next page

  - `pagination.links.prev_page` (string,null, required)
    URL to the previous page

## Response 401 fields (application/json):

  - `success` (boolean, required)
    Request status

  - `errorCode` (string, required)
    Error status code
    Enum: "UNAUTHORIZED"

## Response 403 fields (application/json):

  - `success` (boolean, required)
    Request status

  - `errorCode` (string, required)
    Error status code
    Enum: "INVALID_ABILITY_PROVIDED", "IP_ADDRESS_NOT_WHITELISTED"

## Response 404 fields (application/json):

  - `success` (boolean, required)
    Request status

  - `errorCode` (string, required)
    Error status code
    Enum: "SERVICE_NOT_FOUND", "TRANSACTION_NOT_FOUND", "ROUTE_NOT_FOUND"

## Response 422 fields (application/json):

  - `success` (boolean, required)
    Request status

  - `errorCode` (string, required)
    Error status code
    Enum: "VALIDATION_ERROR"

  - `errors` (object, required)
    Example: {"amount":["The amount field is required."],"currency":["The selected currency is invalid."]}

  - `errors.amount` (array)
    Example: ["The amount field is required."]