simpay-api (1.0.0)

Download OpenAPI specification:Download

Support: [email protected] URL: https://simpay.pl/kontakt Terms of Service

English version

SMS

Lista usług

Pobieranie listy dostępnych usług SMS na koncie

Authorizations:

bearerAuth

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"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"
}
],
"pagination": {"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": {"next_page": null,
"prev_page": null
}
}
}

Pobieranie informacji o usłudze

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"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"
}
}

Weryfikacja poprawności kodu

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Request Body schema: application/json
required

One of

code required	string (SmsCode) [ 6 .. 6 ] ^[A-Z0-9]{6}$ Kod z wiadomości SMS
number required	integer (ServiceNumbers) Enum: 7055 7155 7255 7355 7455 7555 7636 77464 78464 7936 91055 91155 91455 91664 91955 92055 92555 Numer do wysyłki wiadomości SMS

Responses

Request samples

Payload

Content type

application/json

Example

smsCodeWithNumber

{"code": "AB12D6",
"number": 7055
}

Response samples

200
401
403
404

Content type

application/json

Example

smsServiceCheckCodeUsed

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

Pobieranie listy transakcji

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Responses

Response samples

200
401
403
404

Content type

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"
}
],
"pagination": {"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": {"next_page": null,
"prev_page": null
}
}
}

Pobieranie informacji o transakcji

Authorizations:

bearerAuth

path Parameters

serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Id usługi
transactionId required	integer

Responses

Response samples

200
401
403
404

Content type

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

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"number": 7055,
"value": 2,
"value_net": 2.46,
"adult": false
}
],
"pagination": {"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": {"next_page": null,
"prev_page": null
}
}
}

Pobieranie informacji o numerze dla usługi

Authorizations:

bearerAuth

path Parameters

serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Id usługi
number required	integer

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"number": 7055,
"value": 2,
"value_net": 2.46,
"adult": false
}
}

Pobieranie wszystkich dostępnych numerów

Authorizations:

bearerAuth

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"number": 7055,
"value": 2,
"value_net": 2.46,
"adult": false
}
],
"pagination": {"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": {"next_page": null,
"prev_page": null
}
}
}

Pobieranie numeru

Authorizations:

bearerAuth

path Parameters

number

required

integer

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"number": 7055,
"value": 2,
"value_net": 2.46,
"adult": false
}
}

DirectBilling

Sygnatura

Obliczanie sygnatury przy odbieraniu notyfikacji

Sygnature generujemy za pomocą zestawienia ze sobą wszystkich odebranych parametrów (oprócz signature) do API w kolejności z dostępnej powyżej tabli oddzielając je seperatorem | i dodając na końcu klucz dostępny w panelu klienta w usłudze.
Hashowanie musi odbyć się za pomocą sha256.
Przykład:
dc261d4f-31ef-4728-bfd6-97bbe2a5ef0a|e14f8074|transaction_db_payed|11.07|13.67|5.00|https://www.simpay.pl/complete|https://www.simpay.pl/failure|test|123123123|1|klucz

Odbieranie informacji o transakcji Webhook

POST

Request Body schema: application/json

id required	string <uuid> (TransactionId) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Id transakcji
serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Id usługi
status required	string (directbillingTransactionStatus) Enum: "transaction_db_new" "transaction_db_confirmed" "transaction_db_payed" "transaction_db_rejected" Status transakcji
required	object Kwoty transakcji
	object
control	string
number_from required	string Numer telefonu z jakiego została przeprowadzona transakcja
provider required	integer
signature required	string Sygnatura notyfikacji Przeczytaj jak wygenerować sygnature

Responses

Request samples

Payload

Content type

application/json

{"id": "dc261d4f-31ef-4728-bfd6-97bbe2a5ef0a",
"serviceId": "e14f8074",
"status": "transaction_db_payed",
"values": {"net": 11.07,
"gross": 13.61,
"partner": 5
},
"returns": {"complete": "https://www.simpay.pl/complete",
"failure": "https://www.simpay.pl/failure"
},
"number_from": "48123123123",
"provider": 1,
"signature": "a3116cf4f1e960223c2cc3088bf387278b6675255209bdeaf96a2f316a2fadc1"
}

Response samples

200

Content type

text/plain

OK

Pobieranie listy usług

Authorizations:

bearerAuth

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"id": "d151e4f9",
"name": "Usługa testowa",
"suffix": "Test1",
"status": "service_active",
"created_at": "2021-11-08T18:19:16+01:00"
}
],
"pagination": {"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": {"next_page": null,
"prev_page": null
}
}
}

Pobieranie informacji o usłudze

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Responses

Response samples

200
401
403
404

Content type

application/json

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

Kalkulacja prowizji

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

query Parameters

amount

required

number <float>

Kwota jaką chcemy otrzymać “na czysto”

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"orange": {"net": 285.72,
"gross": 351.44
},
"play": {"net": 285.72,
"gross": 351.44
},
"t-mobile": null,
"plus": null
}
}

Pobieranie listy transakcji

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

query Parameters

filter[status]	string (directbillingTransactionStatus) Enum: "transaction_db_new" "transaction_db_confirmed" "transaction_db_payed" "transaction_db_rejected" Status transakcji
filter[phoneNumber]	string Example: filter[phoneNumber]=48123123123 Numer telefonu z jakiego została przeprowadzona trasnakcja
filter[control]	string Pole kontrolne z systemu partnera

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"id": "dc261d4f-31ef-4728-bfd6-97bbe2a5ef0a",
"status": "transaction_db_payed",
"value": 0.34,
"value_netto": 0.24,
"created_at": "2023-02-16T14:52:11+01:00",
"updated_at": "2023-02-16T14:52:11+01:00"
}
],
"pagination": {"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": {"next_page": null,
"prev_page": null
}
}
}

Generowanie transakcji

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Request Body schema: application/json

One of

amount required	number <float> Kwota transakcji
amountType	string Default: "gross" Enum: "required" "net" "gross" Typ kwoty transakcji `required` - ryczałtowa kwota jaką chce uzykać partner, końcowa kwota do zapłaty będzie widoczna na bramce i zależna od operatora `net` - kwota netto `gross` - kwota brutto
description	string <= 128 Opis transakcji widoczny na bramce płatniczej
control	string <= 128 Parametr do wykorzystania przez partnera w celu np. identyfikacji transakcji
	object Adresy URL do przekierowania klienta po transakcji
phoneNumber	string Wymuszony numer telefonu
steamid	string <steamId64> Opcjonalne pole ( steamid64 )

Responses

Request samples

Payload

Content type

application/json

Example

directbillingTransactionCreateAll

{"amount": 19.99,
"amountType": "gross",
"description": "Płatność za wirtualne produkty",
"control": "96125f23-d549-4bfc-a845-b781b5f1ad03",
"returns": {"success": "https://www.simpay.pl/success",
"failure": "https://www.simpay.pl/failure"
},
"phoneNumber": "48123123123"
}

Response samples

200
401
403
404
422

Content type

application/json

{"success": true,
"data": {"transactionId": "1d87a1b3-18f8-4146-bcb1-c0c9f293b04f",
"redirectUrl": "https://db.simpay.pl/1d87a1b3-18f8-4146-bcb1-c0c9f293b04f"
}
}

Pobieranie informacji o transakcji

Authorizations:

bearerAuth

path Parameters

serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Id usługi
transactionId required	string <uuid> (TransactionId) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Id transakcji

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"id": "dc261d4f-31ef-4728-bfd6-97bbe2a5ef0a",
"status": "transaction_db_payed",
"phoneNumber": null,
"control": "1d87a1b3-18f8-4146-bcb1-c0c9f293b04f",
"value": 16.67,
"value_netto": 10,
"operator": "t-mobile",
"notify": {"is_send": false,
"last_send_at": "2023-02-16T14:52:11+01:00",
"count": 1
},
"created_at": "2023-02-16T14:52:11+01:00",
"updated_at": "2023-02-16T14:52:11+01:00"
}
}

Płatności online

Sygnatura

Obliczanie sygnatury przy odbieraniu notyfikacji

Sygnature generujemy za pomocą zestawienia ze sobą wszystkich odebranych parametrów (oprócz signature) do API w kolejności z dostępnej powyżej tabli oddzielając je seperatorem | i dodając na końcu klucz dostępny w panelu klienta w usłudze.
Hashowanie musi odbyć się za pomocą sha256.
Przykład dla waluty PLN:
dc261d4f-31ef-4728-bfd6-97bbe2a5ef0a|e14f8074|transaction_paid|10|PLN|9.9|88643ada8857f25a1f391395f922f7db|blik|production|klucz

Przykład dla waluty innej niż PLN:
dc261d4f-31ef-4728-bfd6-97bbe2a5ef0a|e14f8074|transaction_paid|4.31|PLN|0.06|88643ada8857f25a1f391395f922f7db|blik|production|1.00|EUR|4.3123|klucz

Odbieranie informacji o transakcji Webhook

POST

Request Body schema: application/json

id required	string <uuid> (TransactionId) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Id transakcji
service_id required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Id usługi
status required	string (paymentTransactionStatus) Enum: "transaction_new" "transaction_confirmed" "transaction_generated" "transaction_paid" "transaction_failed" "transaction_expired" "transaction_canceled" Status transakcji
required	object Obiekt rozliczeniowy
control	string Pole do wykorzystania przez partnera
channel required	string Kanał płatności
environment required	string Enum: "production" "test"
	object Informacje o przewalutowaniach. Obiekt wysyłany tylko wtedy, gdy przy generowaniu transakcji pole `currency` było inne niż `PLN`.
signature required	string Sygnatura notyfikacji Przeczytaj jak wygenerować sygnature Partner ma obowiązek weryfikować sygnaturę przy otrzymaniu powiadomienia, można też wykonać request do endpointu Pobieranie szczegółów transakcji

Responses

Request samples

Payload

Content type

application/json

{"id": "dc261d4f-31ef-4728-bfd6-97bbe2a5ef0a",
"service_id": "e14f8074",
"status": "transaction_paid",
"amount": {"value": 10,
"currency": "PLN",
"commission": 9.9
},
"control": "88643ada8857f25a1f391395f922f7db",
"channel": "blik",
"environment": "production",
"signature": "a3116cf4f1e960223c2cc3088bf387278b6675255209bdeaf96a2f316a2fadc1"
}

Response samples

200

Content type

text/plain

OK

Pobieranie listy usług

Authorizations:

bearerAuth

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"id": "d151e4f9",
"name": "Usługa testowa",
"status": "service_active",
"created_at": "2021-11-08T18:19:16+01:00"
}
],
"pagination": {"total": 1,
"count": 1,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": {"next_page": null,
"prev_page": null
}
}
}

Pobieranie szczegółów usługi

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Responses

Response samples

200
401
403
404

Content type

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

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"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
}
}
]
}

Pobieranie listy transakcji

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"id": "528bd43f-d08a-43f5-9462-861e54db37bf",
"status": "transaction_paid",
"amount": 24.99,
"control": null,
"channel": "nest",
"paid_at": "2023-12-07T05:21:50+01:00",
"created_at": "2023-12-07T05:20:30+01:00",
"updated_at": "2023-12-07T05:21:50+01:00"
},
{"id": "0238d92e-0dd9-469a-9aa9-0505974336a3",
"status": "transaction_paid",
"amount": 24.99,
"control": null,
"channel": "blik",
"paid_at": "2023-12-07T06:21:50+01:00",
"created_at": "2023-12-07T06:20:30+01:00",
"updated_at": "2023-12-07T06:21:50+01:00"
}
],
"pagination": {"total": 2,
"count": 2,
"per_page": 15,
"current_page": 1,
"total_pages": 1,
"links": {"next_page": null,
"prev_page": null
}
}
}

Generowanie transakcji

Authorizations:

bearerAuth

path Parameters

serviceId

required

string (ServiceId) = 8 characters ^[0-9a-f]{8}$

Id usługi

Request Body schema: application/json

amount required	number <float> >= 1 Kwota transakcji
currency	string Default: "PLN" Waluta transakcji
description	string <= 64 characters Opis transakcji nadany przez partnera, prezentowany na bramce płatności
control	string <= 255 characters Pole do wykorzystania przez partnera
	object or null Obiekt podstawowych informacji o płacącym
	object or null Obiekt informacji do antifrauda
	object or null (paymentCustomerFull)
	object or null (paymentCustomerFull)
	Array of objects or null (paymentCartItem)
	object or null
directChannel	string W tym polu można przesłać Id kanału, wtedy płacący zostanie przekierowany od razu na stronę podanego kanału np. przy podaniu `blik` zostanie przekierowany od razu na bramkę płatności BLIK. Wymagane jest wtedy przesłanie `antifraud.useragent` oraz `customer.ip`.
channels	Array of strings or null Tablica z Id kanałów płatności, które zostaną wyświetlone płacącemu na bramce po przekierowaniu na url transakcji Listę dostępnych kanałów wraz z ich Id możemy uzyskać tutaj Pobieranie listy kanałów dla usługi
	object or null Obiekt w którym możemy zdefiniować które typu kanłów mają być dostępne na bramce płatności
referer	string [ 6 .. 64 ] characters

Responses

Request samples

Payload

Content type

application/json

{"amount": 1,
"currency": "PLN",
"description": "string",
"control": "string",
"customer": {"name": "string",
"email": "[email protected]",
"ip": "string"
},
"antifraud": {"useragent": "string",
"steamid": 0,
"mcusername": "string",
"mcid": "string"
},
"billing": {"name": "string",
"surname": "string",
"street": "string",
"building": "string",
"flat": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string",
"company": "string"
},
"shipping": {"name": "string",
"surname": "string",
"street": "string",
"building": "string",
"flat": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"country": "string",
"company": "string"
},
"cart": [{"name": "string",
"quantity": 1,
"price": 0.01,
"producer": "string",
"category": "string",
"code": "string"
}
],
"returns": {"success": "string",
"failure": "string"
},
"directChannel": "string",
"channels": ["string"
],
"channelTypes": {"blik": true,
"transfer": true,
"cards": true,
"ewallets": true,
"paypal": true
},
"referer": "string"
}

Response samples

200
401
403
404
422

Content type

application/json

{"success": true,
"data": {"transactionId": "1d87a1b3-18f8-4146-bcb1-c0c9f293b04f",
"redirectUrl": "https://pay.simpay.pl/1d87a1b3-18f8-4146-bcb1-c0c9f293b04f"
}
}

Pobieranie szczegółów transakcji

Authorizations:

bearerAuth

path Parameters

serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Id usługi
transactionId required	string <uuid> (TransactionId) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Id transakcji

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": {"id": "328bd42d-d08b-43f6-9463-869e5bd32b4",
"status": "transaction_paid",
"amount": {"value": 19.99,
"currency": "PLN",
"commission": 0.98
},
"channel": "nest",
"control": null,
"description": null,
"redirects": {"success": null,
"failure": null
},
"customer": {"name": null,
"email": "[email protected]"
},
"billing": {"name": null,
"surname": null,
"street": null,
"building": null,
"flat": null,
"city": null,
"region": null,
"postalCode": null,
"country": null,
"company": null
},
"shipping": {"name": null,
"surname": null,
"street": null,
"building": null,
"flat": null,
"city": null,
"region": null,
"postalCode": null,
"country": null,
"company": null
},
"cart": null,
"paid_at": "2023-12-07T05:21:50+01:00",
"expires_at": null,
"created_at": "023-12-07T05:20:30+01:00",
"updated_at": "2023-12-07T05:21:50+01:00"
}
}

simpay-api (1.0.0)

SMS

Lista usług

Authorizations:

Responses

Response samples

Pobieranie informacji o usłudze

Authorizations:

path Parameters

Responses

Response samples

Weryfikacja poprawności kodu

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Pobieranie listy transakcji

Authorizations:

path Parameters

Responses

Response samples

Pobieranie informacji o transakcji

Authorizations:

path Parameters

Responses

Response samples

Pobieranie informacji o numerach dla usługi

Authorizations:

path Parameters

Responses

Response samples

Pobieranie informacji o numerze dla usługi

Authorizations:

path Parameters

Responses

Response samples

Pobieranie wszystkich dostępnych numerów

Authorizations:

Responses

Response samples

Pobieranie numeru

Authorizations:

path Parameters

Responses

Response samples

DirectBilling

Sygnatura

Obliczanie sygnatury przy odbieraniu notyfikacji

Odbieranie informacji o transakcji Webhook

Request Body schema: application/json

Responses

Request samples

Response samples

Pobieranie listy usług

Authorizations:

Responses

Response samples

Pobieranie informacji o usłudze

Authorizations:

path Parameters

Responses

Response samples

Kalkulacja prowizji

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Pobieranie listy transakcji

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Generowanie transakcji

Authorizations:

path Parameters

Request Body schema: application/json

Request Body schema: application/json
required