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

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

https://api.simpay.pl/

Operacje

Żądanie

Pobieranie listy dostępnych usług SMS na koncie

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objects(smsServiceList)wymagany
Przykład: [{"id":"d151e4f9","type":"ONE_TIME_CODE","status":"service_active","name":"TEST","prefix":"SIM","suffix":"TESTSIMPAY","adult":false,"created_at":"2021-11-08T18:18:53+01:00"}]
data[].​idstring(ServiceId)= 8 characters^[0-9a-f]{8}$wymagany

Id usługi

data[].​typestring(ServiceType)wymagany

Typ usługi SMS

Enum"ONE_TIME_CODE""CODE_PACK""API_URL"
data[].​statusstring(ServiceStatus)wymagany

Status usługi

Enum"service_new""service_active""service_blocked""service_rejected""service_verify""service_ongoing_registration"
data[].​namestringwymagany

Nazwa usługi

data[].​prefixstringwymagany

Prefix usługi, czyli pierwszy człon treści SMS np. SIM

data[].​suffixstringwymagany

Suffix usługi, czyli drugi człon treści SMS

data[].​descriptionstring

Opis usługi

data[].​adultbooleanwymagany

Informacja o tym czy usługa jest 18+

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/sms/{serviceId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objects(smsService)wymagany
Przykład: {"id":"d151e4f9","type":"ONE_TIME_CODE","status":"service_active","name":"TEST","prefix":"SIM","suffix":"TESTSIMPAY","adult":false,"numbers":[7055,7155,7255],"created_at":"2021-11-08T18:18:53+01:00"}
data[].​idstring(ServiceId)= 8 characters^[0-9a-f]{8}$wymagany

Id usługi

data[].​typestring(ServiceType)wymagany

Typ usługi SMS

Enum"ONE_TIME_CODE""CODE_PACK""API_URL"
data[].​statusstring(ServiceStatus)wymagany

Status usługi

Enum"service_new""service_active""service_blocked""service_rejected""service_verify""service_ongoing_registration"
data[].​namestringwymagany

Nazwa usługi

data[].​prefixstringwymagany

Prefix usługi, czyli pierwszy człon treści SMS np. SIM

data[].​suffixstringwymagany

Suffix usługi, czyli drugi człon treści SMS

data[].​descriptionstring

Opis usługi

data[].​adultbooleanwymagany

Informacja o tym czy usługa jest 18+

data[].​numbersArray of integers(ServicesNumbers)wymagany
Elementy Enum705571557255735574557555763677464784647936
data[].​created_atstring(date-time)(DateTime)wymagany

Data utworzenia w formacie: ISO 8601

Odpowiedź
application/json
{ "success": true, "data": { "id": "d151e4f9", "type": "ONE_TIME_CODE", "status": "service_active", "name": "TEST", "prefix": "SIM", "suffix": "TESTSIMPAY", "adult": false, "numbers": [], "created_at": "2021-11-08T18:18:53+01:00" } }

Żądanie

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

Id usługi

Treśćapplication/jsonwymagany
One of:
codestring(SmsCode)[ 6 .. 6 ]^[A-Z0-9]{6}$wymagany

Kod z wiadomości SMS

numberinteger(ServiceNumbers)wymagany

Numer do wysyłki wiadomości SMS

Enum705571557255735574557555763677464784647936
curl -i -X POST \
  'https://docs.simpay.pl/_mock/apis/sms/{serviceId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "AB12D6",
    "number": 7055
  }'

Odpowiedzi

Treśćapplication/json
One of:
successbooleanwymagany

Request status

Przykład: true
dataArray of objects(smsServiceCheckCodeUsedData)wymagany
Przykład: {"used":true,"code":"ABC1D6","test":true,"from":"48123123123","number":7055,"value":0.5,"send_at":"2021-11-14T19:00:36+01:00"}
data[].​usedbooleanwymagany

Informacja czy kod został wykorzystany

data[].​codestringwymagany

Kod z SMS

data[].​testbooleanwymagany

Informacja czy kod testowy

data[].​fromintegerwymagany

Numer z jakiego wysłano SMS

data[].​numberinteger(ServiceNumbers)wymagany

Numer do wysyłki wiadomości SMS

Enum705571557255735574557555763677464784647936
data[].​valuenumber(float)wymagany

Kwota netto SMSa

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

Data utworzenia w formacie: ISO 8601

Odpowiedź
application/json
{ "success": true, "data": { "used": true, "code": "ABC1D6", "test": true, "from": "48123123123", "number": 7055, "value": 0.5, "send_at": "2021-11-14T19:00:36+01:00" } }

Żą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/sms/{serviceId}/transactions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objects(ServiceTransaction)wymagany
Przykład: [{"id":1,"from":48123123123,"code":"ABC1D6","used":false,"send_number":7055,"value":0.5,"send_at":"2021-11-14T19:00:36+01:00"}]
data[].​idintegerwymagany

Id transakcji SMS

data[].​fromintegerwymagany

Numer z jakiego wysłano SMS

data[].​codestringwymagany

Kod z SMS

data[].​usedbooleanwymagany

Informacja czy kod został wykorzystany

data[].​send_numberinteger(ServiceNumbers)wymagany

Numer do wysyłki wiadomości SMS

Enum705571557255735574557555763677464784647936
data[].​valuenumber(float)wymagany

Kwota netto SMSa

data[].​send_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

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataobject(ServiceTransaction)wymagany
data.​idintegerwymagany

Id transakcji SMS

data.​fromintegerwymagany

Numer z jakiego wysłano SMS

data.​codestringwymagany

Kod z SMS

data.​usedbooleanwymagany

Informacja czy kod został wykorzystany

data.​send_numberinteger(ServiceNumbers)wymagany

Numer do wysyłki wiadomości SMS

Enum705571557255735574557555763677464784647936
data.​valuenumber(float)wymagany

Kwota netto SMSa

data.​send_atstring(date-time)(DateTime)wymagany

Data utworzenia w formacie: ISO 8601

Odpowiedź
application/json
{ "success": true, "data": { "id": 1, "from": 48123123123, "code": "ABC1D6", "used": false, "send_number": 7055, "value": 0.5, "send_at": "2021-11-14T19:00:36+01:00" } }

Pobieranie informacji o numerach 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/sms/{serviceId}/numbers' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objects(smsNumber)wymagany
Przykład: [{"number":7055,"value":2,"value_net":2.46,"adult":false}]
data[].​numberinteger(ServiceNumbers)wymagany

Numer do wysyłki wiadomości SMS

Enum705571557255735574557555763677464784647936
data[].​valuenumber(float)wymagany
data[].​value_netnumber(float)wymagany
data[].​adultbooleanwymagany
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": {} } }

Pobieranie informacji o numerze dla usługi

Żądanie

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

Id usługi

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany
Przykład: true
dataobject(smsNumber)wymagany
data.​numberinteger(ServiceNumbers)wymagany

Numer do wysyłki wiadomości SMS

Enum705571557255735574557555763677464784647936
data.​valuenumber(float)wymagany
data.​value_netnumber(float)wymagany
data.​adultbooleanwymagany
Odpowiedź
application/json
{ "success": true, "data": { "number": 7055, "value": 2, "value_net": 2.46, "adult": false } }

Pobieranie wszystkich dostępnych numerów

Żądanie

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objects(smsNumber)wymagany
Przykład: [{"number":7055,"value":2,"value_net":2.46,"adult":false}]
data[].​numberinteger(ServiceNumbers)wymagany

Numer do wysyłki wiadomości SMS

Enum705571557255735574557555763677464784647936
data[].​valuenumber(float)wymagany
data[].​value_netnumber(float)wymagany
data[].​adultbooleanwymagany
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
numberintegerwymagany
curl -i -X GET \
  'https://docs.simpay.pl/_mock/apis/sms/numbers/{number}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany
Przykład: true
dataobject(smsNumber)wymagany
data.​numberinteger(ServiceNumbers)wymagany

Numer do wysyłki wiadomości SMS

Enum705571557255735574557555763677464784647936
data.​valuenumber(float)wymagany
data.​value_netnumber(float)wymagany
data.​adultbooleanwymagany
Odpowiedź
application/json
{ "success": true, "data": { "number": 7055, "value": 2, "value_net": 2.46, "adult": false } }
OperacjeWebhooki
Operacje