Skip to content
/
Retrieve list of BLIK ali...

simpay-api (1.0.0)

Polish version

Download OpenAPI description
index.json
index.yaml
Overview
URL

https://simpay.pl/kontakt

Support

kontakt@simpay.pl

Terms of Service

Languages
Servers
Mock server

https://docs.simpay.pl/_mock/en/apis/

https://api.simpay.pl/

SMS

Operations

DirectBilling

OperationsWebhooks

Online Payments

Operations

Execute BLIK Recurring Payment

Request

See https://docs.simpay.pl/payment/blik-recurrent for more information.

Security
bearerAuth
Path
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

subscriptionIdstring(uuid)(SubscriptionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Subscription ID

Bodyapplication/json
transactionIdstring(uuid)(TransactionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Transaction ID

attemptinteger or null[ 0 .. 9 ]

Retry number of the Recurring Payment

descriptionsobject or null

Additional descriptions passed to the payer's bank

aliasobject or null

Alias information

curl -i -X POST \
  'https://docs.simpay.pl/_mock/en/apis/payment/{serviceId}/blik/subscriptions/{subscriptionId}/autopayment' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "9475bfd4-0935-4945-8621-2ec22e561ac9",
    "descriptions": {
      "line1": "Music subscription for September"
    },
    "alias": {
      "label": "Payment for Gold plan",
      "noDelay": true
    }
  }'

Responses

Subscription forwarded for processing

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataobjectrequired
Example: {"needsUserConfirmation":false}
data.​needsUserConfirmationbooleanrequired

If false – the transaction was immediately forwarded to BLIK. If true – the antifraud system detected risk and the transaction is awaiting manual confirmation by the payer

Response
application/json
{
  "success": true,
  "data": {
    "needsUserConfirmation": false
  }
}

Retrieve list of BLIK aliases

Request

Security
bearerAuth
Path
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

Query
filter[status]string(blikAliasStatus)

BLIK alias status

Enum"alias_pending_registration""alias_active""alias_expired""alias_unregistered"
Example: filter[status]=alias_active
filter[type]string(blikAliasType)

BLIK alias type

Enum"PAYID""UID"
Example: filter[type]=PAYID
filter[uuid]string(uuid)(AliasId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Alias ID

Example: filter[uuid]=019970c6-3ce8-71e7-8214-20fd635532fb
filter[value]string<= 64 characters

BLIK alias value

Example: filter[value]=019970c6-3ce8-71e7-8214-20fd635532fb
pageinteger>= 1

Page number

Default 1
Example: page=1
perPageinteger[ 1 .. 50 ]

Number of results per page

Default 20
Example: perPage=20
sortstring

Sort order (-created_at = newest first, created_at = oldest first)

Enum"-created_at""created_at"
curl -i -X GET \
  'https://docs.simpay.pl/_mock/en/apis/payment/{serviceId}/blik/aliases?filter%5Bstatus%5D=alias_active&filter%5Btype%5D=PAYID&filter%5Buuid%5D=019970c6-3ce8-71e7-8214-20fd635532fb&filter%5Bvalue%5D=019970c6-3ce8-71e7-8214-20fd635532fb&page=1&perPage=20&sort=-created_at' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataArray of objectsrequired
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[].​idstring(uuid)(AliasId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Alias ID

data[].​typestring(blikAliasType)required

BLIK alias type

Enum"PAYID""UID"
data[].​valuestring<= 64 charactersrequired

Alias value

Example: "AABBCC"
data[].​labelstring<= 35 charactersrequired

Label displayed in the mobile app

Example: "Payment for a premium package on service aaa"
data[].​blik_keystring or null

Alias identifier in BLIK (for a PAYID alias this will be empty)

Example: null
data[].​statusstring(blikAliasStatus)required

BLIK alias status

Enum"alias_pending_registration""alias_active""alias_expired""alias_unregistered"
data[].​expires_atstring(date-time)(DateTime)

Creation date in format: ISO 8601

data[].​created_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

data[].​updated_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

data[].​subscriptionobject
paginationobject(Pagination)required
pagination.​totalintegerrequired

Total number of records

Example: 1
pagination.​countintegerrequired

Number of records on the current page

Example: 1
pagination.​per_pageintegerrequired

Maximum number of records per page

Example: 15
pagination.​current_pageintegerrequired

Current page

Example: 1
pagination.​total_pagesintegerrequired

Total number of pages

Example: 1
pagination.​linksobjectrequired

URLs to pages

pagination.​links.​next_pagestring or null(url)required

URL to the next page

Example: null
pagination.​links.​prev_pagestring or null(url)required

URL to the previous page

Example: null
Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … }
  ],
  "pagination": {
    "total": 2,
    "count": 2,
    "per_page": 20,
    "current_page": 1,
    "total_pages": 1,
    "links": { … }
  }
}

Delete/Unregister alias

Request

See https://docs.simpay.pl/payment/blik-recurrent for more information.

Security
bearerAuth
Path
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

Bodyapplication/json
One of:
uuidstring(uuid)(AliasId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Alias ID

reasonstring or null<= 20 characters

Reason for unregistration – will be sent to BLIK and the payer

curl -i -X DELETE \
  'https://docs.simpay.pl/_mock/en/apis/payment/{serviceId}/blik/aliases' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuid": "0198a54d-05d9-7177-9ac6-5d9831bc988d",
    "reason": "Plan cancellation"
  }'

Responses

The alias has been unregistered. An IPN blik:alias_status_changed will be sent

Response
No content
© 2025 Payments Solution Sp. z o.o. - All rights reserved.