Przejdź do treści
Referencja API
/
/
Utworzenie subskrypcji

simpay-api (1.0.0)

English version

Pobierz opis OpenAPI
index.json
index.yaml
Przegląd
URL

https://simpay.pl/kontakt

Support

kontakt@simpay.pl

Warunki świadczenia usług

Języki
Serwery
Mock server

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

https://api.simpay.pl/

SMS

Operacje

DirectBilling

OperacjeWebhooki

Płatności online

Operacje

Pobieranie listy subskrypcji

Żądanie

Zobacz https://docs.simpay.pl/payment/blik-recurrent po więcej informacji.

Bezpieczeństwo
bearerAuth
Ścieżka
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$wymagany

Id usługi

Zapytanie
filter[status]string(subscriptionStatus)

Status subskrypcji

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

Tryb subskrypcji

Enum"BLIK""CARD"
Przykład: 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]...

Id subskrypcji

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

Numer strony

Domyślny 1
Przykład: page=1
perPageinteger[ 1 .. 50 ]

Ile wyników na stronę pokazać

Domyślny 20
Przykład: perPage=20
sortstring

Pokazuj w kolejności od (-created_at = najnowszych, created_at = najstarszych)

Enum"-created_at""created_at"
curl -i -X GET \
  'https://docs.simpay.pl/_mock/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>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objectswymagany
Przykład: [{"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":"Płatność za pakiet premium","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":"Subskrypcja za muzykę","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":"Rezygnacja przez użytkownika"},"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]...wymagany

Id subskrypcji

data[].​statusstring(subscriptionStatus)wymagany

Status subskrypcji

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

Tryb subskrypcji

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

Częstotliwość subskrypcji

Przykład: "1M"
data[].​initiation_datestring or null

Data pierwszej możliwej Płatności Powtarzalnej

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

Całkowita kwota, która jest dla tej Płatności Powtarzalnej

Przykład: 4000
data[].​total_transactions_limitinteger or null

Całkowita ilość możliwych transakcji dla Płatności Powtarzalnej

Przykład: 12
data[].​cancelledobject or null
data[].​created_atstring(date-time)(DateTime)wymagany

Data utworzenia w formacie: ISO 8601

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

Data utworzenia w formacie: ISO 8601

paginationobject(Pagination)wymagany
pagination.​totalintegerwymagany

Liczba wszystkich rekordów

Przykład: 1
pagination.​countintegerwymagany

Liczba rekordów na danej stronie

Przykład: 1
pagination.​per_pageintegerwymagany

Maksymalna ilość rekordów na strone

Przykład: 15
pagination.​current_pageintegerwymagany

Aktualna strona

Przykład: 1
pagination.​total_pagesintegerwymagany

Ilość stron

Przykład: 1
pagination.​linksobjectwymagany

Adresy URL do stron

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

Adres URL do następnej strony

Przykład: null
pagination.​links.​prev_pagestring or null(url)wymagany

Adres URL do poprzedniej strony

Przykład: null
Odpowiedź
application/json
{
  "success": true,
  "data": [
    { … },
    { … }
  ],
  "pagination": {
    "total": 2,
    "count": 2,
    "per_page": 20,
    "current_page": 1,
    "total_pages": 1,
    "links": { … }
  }
}

Utworzenie subskrypcji

Żądanie

Zobacz https://docs.simpay.pl/payment/blik-recurrent po więcej informacji.

Bezpieczeństwo
bearerAuth
Ścieżka
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$wymagany

Id usługi

Treśćapplication/json
transactionIdstring(uuid)(TransactionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...wymagany

Id transakcji

ticketobjectwymagany

Obiekt kodu BLIK

Przykład: {"T6":"462755"}
ticket.​T6string= 6 characterswymagany

6-cyfrowy Kod BLIK

Przykład: "462755"
aliasobjectwymagany

Informacje o Aliasie BLIK

Przykład: {"value":"AAABBCC","type":"PAYID","label":"Płatność za plan premium w serwisie aaa"}
alias.​valuestring[ 1 .. 64 ] characterswymagany

Wartość aliasu (np. ID subskrypcji)

Przykład: "AAABBCC"
alias.​typestringwymagany

Typ aliasu (dla subskrypcji - PAYID)

Wartość"PAYID"
Przykład: "PAYID"
alias.​labelstring[ 1 .. 35 ] characters

Etykieta widoczna w aplikacji bankowej płacącego

Przykład: "Płatność za plan premium w serwisie aaa"
optionsModel A (object) or Model O (object) or Model M (object)wymagany
One of:

Opcje dla modelu A

options.​modelstringwymagany
Wartość"A"
options.​expiresAtstring(datetime)wymagany

Data wygaśnięcia aliasu, max +10 lat

options.​frequencystring[ 2 .. 4 ] characterswymagany

Częstotliwość subskrypcji

options.​amountLimitPerTransactionnumber[ 1 .. 4000 ]wymagany

Limit kwoty na pojedynczą transakcję

options.​initiationDatestring(date)wymagany

Data pierwszej dozwolonej Płatności Powtarzalnej

options.​amountLimitTotalnumber>= 1wymagany

Całościowy limit kwoty subskrypcji

options.​transactionsCountLimitnumber>= 1

Limit ilościowy Płatności Powtarzalnych w ramach jednego aliasu

descriptionsobject or null

Dodatkowe opisy przekazywane do banku płacącego

curl -i -X POST \
  'https://docs.simpay.pl/_mock/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": "Płatność za plan premium w serwisie aaa"
    },
    "options": {
      "model": "A",
      "expiresAt": "2030-09-22",
      "frequency": "30D",
      "amountLimitPerTransaction": 30,
      "initiationDate": "2025-09-22",
      "amountLimitTotal": 30000
    }
  }'

Odpowiedzi

Subskrypcja oraz alias utworzone

Treśćapplication/json
successbooleanwymagany

Status zapytania

Przykład: true
dataobjectwymagany
Przykład: {"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]...wymagany

Id subskrypcji

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

Id aliasu

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

Dokonaj Płatności Powtarzalnej BLIK

Żądanie

Zobacz https://docs.simpay.pl/payment/blik-recurrent po więcej informacji.

Bezpieczeństwo
bearerAuth
Ścieżka
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$wymagany

Id usługi

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

Id subskrypcji

Treśćapplication/json
transactionIdstring(uuid)(TransactionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...wymagany

Id transakcji

attemptinteger or null[ 0 .. 9 ]

Numer ponowienia Płatności Powtarzalnej

descriptionsobject or null

Dodatkowe opisy przekazywane do banku płacącego

aliasobject or null

Informacje do aliasu

curl -i -X POST \
  'https://docs.simpay.pl/_mock/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": "Subskrypcja na muzykę za wrzesień"
    },
    "alias": {
      "label": "Płatność za plan Gold",
      "noDelay": true
    }
  }'

Odpowiedzi

Subskrypcja przekazana do realizacji

Treśćapplication/json
successbooleanwymagany

Status zapytania

Przykład: true
dataobjectwymagany
Przykład: {"needsUserConfirmation":false}
data.​needsUserConfirmationbooleanwymagany

Jeśli wartość false - transakcja przekazana od razu do BLIK. Jeśli true - system antifraud wykrył ryzyko i transakcja czeka na ręczne potwierdzenie przez płacącego

Odpowiedź
application/json
{
  "success": true,
  "data": {
    "needsUserConfirmation": false
  }
}
© 2025 Payments Solution Sp. z o.o. - All rights reserved.