Skip to content
/
Create a subscription

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

Retrieve subscription list

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

Query
filter[status]string(subscriptionStatus)

Subscription status

Enum"subscription_pending""subscription_active""subscription_cancelled""subscription_expired""subscription_finished""subscription_fraudulent"
Example: filter[status]=subscription_active
filter[mode]string(subscriptionMode)

Subscription mode

Enum"BLIK""CARD"
Example: filter[mode]=BLIK
filter[uuid]string(uuid)(SubscriptionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...

Subscription ID

Example: filter[uuid]=019970c6-3d3e-708c-9313-5f89e251e2c0
pageinteger>= 1

Page number

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

How many results to display 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}/subscriptions?filter%5Bstatus%5D=subscription_active&filter%5Bmode%5D=BLIK&filter%5Buuid%5D=019970c6-3d3e-708c-9313-5f89e251e2c0&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-3d3e-708c-9313-5f89e251e2c0","status":"subscription_active","mode":"BLIK","blik":{"model":"O","alias":{"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"}},"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-05e1-72b8-b835-f2258609bb52","status":"subscription_cancelled","mode":"BLIK","blik":{"model":"O","alias":{"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"}},"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)(SubscriptionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Subscription ID

data[].​statusstring(subscriptionStatus)required

Subscription status

Enum"subscription_pending""subscription_active""subscription_cancelled""subscription_expired""subscription_finished""subscription_fraudulent"
data[].​modestring(subscriptionMode)required

Subscription mode

Enum"BLIK""CARD"
data[].​blikobject
data[].​frequencystring or null

Subscription frequency

Example: "1M"
data[].​initiation_datestring or null

Date of the first possible Recurring Payment

Example: "2025-08-13T23:15:13+02:00"
data[].​total_amount_limitnumber or null

Total amount limit for this Recurring Payment

Example: 4000
data[].​total_transactions_limitinteger or null

Total number of possible transactions for this Recurring Payment

Example: 12
data[].​cancelledobject or null
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

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": { … }
  }
}

Create a subscription

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
transactionIdstring(uuid)(TransactionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Transaction ID

ticketobjectrequired

BLIK code object

Example: {"T6":"462755"}
ticket.​T6string= 6 charactersrequired

6-digit BLIK code

Example: "462755"
aliasobjectrequired

BLIK alias information

Example: {"value":"AAABBCC","type":"PAYID","label":"Payment for premium plan in aaa service"}
alias.​valuestring[ 1 .. 64 ] charactersrequired

Alias value (e.g., subscription ID)

Example: "AAABBCC"
alias.​typestringrequired

Alias type (for subscriptions - PAYID)

Value"PAYID"
Example: "PAYID"
alias.​labelstring[ 1 .. 35 ] characters

Label visible in the payer's banking app

Example: "Payment for premium plan in aaa service"
optionsModel A (object) or Model O (object) or Model M (object)required
One of:

Options for model A

options.​modelstringrequired
Value"A"
options.​expiresAtstring(datetime)required

Alias expiration date, max +10 years

options.​frequencystring[ 2 .. 4 ] charactersrequired

Subscription frequency

options.​amountLimitPerTransactionnumber[ 1 .. 4000 ]required

Transaction amount limit per single transaction

options.​initiationDatestring(date)required

Date of the first allowed recurring payment

options.​amountLimitTotalnumber>= 1required

Total subscription amount limit

options.​transactionsCountLimitnumber>= 1

Quantity limit of recurring payments under one alias

descriptionsobject or null

Additional descriptions passed to the payer's bank

curl -i -X POST \
  'https://docs.simpay.pl/_mock/en/apis/payment/{serviceId}/blik/subscriptions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transactionId": "bda2d37c-e64d-4855-af7c-91aac91a0d6a",
    "ticket": {
      "T6": "462755"
    },
    "alias": {
      "value": "AABBCC",
      "type": "PAYID",
      "label": "Payment for premium plan in aaa service"
    },
    "options": {
      "model": "A",
      "expiresAt": "2030-09-22",
      "frequency": "30D",
      "amountLimitPerTransaction": 30,
      "initiationDate": "2025-09-22",
      "amountLimitTotal": 30000
    }
  }'

Responses

Subscription and alias created

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataobjectrequired
Example: {"subscriptionId":"019970c6-3d3e-708c-9313-5f89e251e2c0","aliasId":"019970c6-3ce8-71e7-8214-20fd635532fb"}
data.​subscriptionIdstring(uuid)(SubscriptionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Subscription ID

data.​aliasIdstring(uuid)(AliasId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Alias ID

Response
application/json
{
  "success": true,
  "data": {
    "subscriptionId": "019970c6-3d3e-708c-9313-5f89e251e2c0",
    "aliasId": "019970c6-3ce8-71e7-8214-20fd635532fb"
  }
}

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
  }
}
© 2025 Payments Solution Sp. z o.o. - All rights reserved.