Skip to content
/
Provide BLIK code for Lev...

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

Retrieving a list of currencies for the service

Request

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

Service ID

curl -i -X GET \
  'https://docs.simpay.pl/_mock/en/apis/payment/{serviceId}/currencies' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataArray of objectsrequired
Example: [{"iso":"PLN","pln_rate":"1.0000000000","nbp_table":"A","prefix":null,"suffix":" zł","updated_at":"2025-05-10T13:04:32+02:00"},{"iso":"EUR","pln_rate":"4.3238000000","nbp_table":"A","prefix":"€","suffix":null,"updated_at":"2025-05-10T13:04:32+02:00"},{"iso":"ARS","pln_rate":"0.0034150000","nbp_table":"B","prefix":"ARS$","suffix":null,"updated_at":"2025-05-10T13:04:32+02:00"}]
data[].​isostringrequired

Currency ISO code (PLN, USD, EUR, BRL etc.)

data[].​pln_ratestringrequired

Currency rate according to the NBP exchange rate

data[].​nbp_tablestringrequired

NBP exchange rate table

data[].​prefixstring or null

Currency prefix

data[].​suffixstring or null

Currency suffix

data[].​updated_atstring(date)required

Last currency update date

Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … },
    { … }
  ]
}

Provide BLIK code for Level 0 transaction

Request

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

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

Service ID

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

Transaction ID

Bodyapplication/json
ticketobjectrequired

BLIK code object

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

6-digit BLIK code

Example: "123123"
curl -i -X POST \
  'https://docs.simpay.pl/_mock/en/apis/payment/{serviceId}/blik/level0/{transactionId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ticket": {
      "T6": "123123"
    }
  }'

Responses

Payment confirmation sent to the Payer’s Banking App

Response
No content

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