Przejdź do treści
Pobierz opis OpenAPI
Języki
Serwery
Mock server

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

https://api.simpay.pl/

Operacje
OperacjeWebhooki
Operacje

Żądanie

Bezpieczeństwo
bearerAuth
curl -i -X GET \
  https://docs.simpay.pl/_mock/apis/payment \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objectswymagany
Przykład: [{"id":"d151e4f9","name":"Usługa testowa","status":"service_active","created_at":"2021-11-08T18:19:16+01:00"}]
data[].​idstring(ServiceId)= 8 characters^[0-9a-f]{8}$wymagany

Id usługi

data[].​namestringwymagany

Nazwa usługi

data[].​statusstring(ServiceStatus)wymagany

Status usługi

Enum"service_new""service_active""service_blocked""service_rejected""service_verify""service_ongoing_registration"
data[].​created_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": 1, "count": 1, "per_page": 15, "current_page": 1, "total_pages": 1, "links": {} } }

Żądanie

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

Id usługi

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataobjectwymagany
Przykład: {"id":"d151e4f9","name":"Usługa testowa","status":"service_active","created_at":"2021-11-08T18:19:16+01:00"}
data.​idstring(ServiceId)= 8 characters^[0-9a-f]{8}$wymagany

Id usługi

data.​namestringwymagany

Nazwa usługi

Przykład: "Usługa testowa"
data.​statusstring(ServiceStatus)wymagany

Status usługi

Enum"service_new""service_active""service_blocked""service_rejected""service_verify""service_ongoing_registration"
data.​created_atstring(date-time)(DateTime)wymagany

Data utworzenia w formacie: ISO 8601

Odpowiedź
application/json
{ "success": true, "data": { "id": "d151e4f9", "name": "Usługa testowa", "status": "service_active", "created_at": "2021-11-08T18:19:16+01:00" } }

Pobieranie listy kanałów dla usługi

Żądanie

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

Id usługi

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objectswymagany
Przykład: [{"id":"blik","name":"BLIK","type":"blik","img":"https://img.simpay.pl/transfer/banks/blik.png","commission":1.5,"currencies":["PLN"],"amount":{"min":1,"max":20000}},{"id":"mbank","name":"mBank","type":"transfer","img":"https://img.simpay.pl/transfer/banks/mbank.png","commission":1.5,"currencies":["PLN"],"amount":{"min":1,"max":20000}}]
data[].​idstringwymagany

Id kanału płatności

data[].​namestringwymagany

Nazwa kanału

data[].​typestringwymagany

Typ kanału

data[].​imgstring(url)wymagany

Adres URL do grafiki kanału płatności

data[].​commissionnumber(float)wymagany

Prowizja pobierana przez SimPay z płatności

data[].​currenciesArray of stringswymagany

Tablica z dostępnymi walutami

data[].​amountobjectwymagany

Kwoty dostępne dla kanłu

data[].​amount.​minnumber(float)

Kwota minimalna do płatności

data[].​amount.​maxnumber(float)

Kwota maksymalna do płatności

Odpowiedź
application/json
{ "success": true, "data": [ {}, {} ] }