simpay-api (1.0.0)

Download OpenAPI specification:Download

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

Polska wersja

SMS

Service List

Retrieve a list of available SMS services on the account

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

Retrieve Service Information

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

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

Verify Code Validity

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

Request Body schema: application/json
required

One of

code required	string (SmsCode) [ 6 .. 6 ] ^[A-Z0-9]{6}$ Code from the SMS message
number required	integer (ServiceNumbers) Enum: 7055 7155 7255 7355 7455 7555 7636 77464 78464 7936 91055 91155 91455 91664 91955 92055 92555 Number for sending SMS messages

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

Retrieve Transaction List

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

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

Retrieve Transaction Information

Authorizations:

bearerAuth

path Parameters

serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Service ID
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"
}
}

Retrieve Service Numbers Information

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

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

Retrieve Service Number Information

Authorizations:

bearerAuth

path Parameters

serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Service ID
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
}
}

Retrieve All Available Numbers

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

Retrieve Number Information

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

Signature

Calculating the signature for receiving notifications

Generate the signature by concatenating all received parameters (except signature) in the order from the available table above, separating them with a separator |, and adding the key available in the client panel for the service at the end.
Hashing must be done using sha256.
Example:
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|key

Receiving transaction information 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}$ Service ID
status required	string (directbillingTransactionStatus) Enum: "transaction_db_new" "transaction_db_confirmed" "transaction_db_payed" "transaction_db_rejected" Transaction status
required	object Transaction amounts
	object
control	string
number_from required	string Phone number from which the transaction was conducted
provider required	integer
signature required	string Signature of the notification Read how to generate the signature

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

Retrieve Service List

Authorizations:

bearerAuth

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"data": [{"id": "d151e4f9",
"name": "Test service",
"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
}
}
}

Retrieve Service Information

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

Responses

Response samples

200
401
403
404

Content type

application/json

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

Calculate Commission

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

query Parameters

amount

required

number <float>

The amount you want to receive "net"

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

Retrieve Transaction List

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

query Parameters

filter[status]	string (directbillingTransactionStatus) Enum: "transaction_db_new" "transaction_db_confirmed" "transaction_db_payed" "transaction_db_rejected" Transaction status
filter[phoneNumber]	string Example: filter[phoneNumber]=48123123123 Phone number from which the transaction was conducted
filter[control]	string Control field from the partner's system

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

Generate Transaction

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

Request Body schema: application/json

One of

amount required	number <float> Transaction amount
amountType	string Default: "gross" Enum: "required" "net" "gross" Type of transaction amount `required` - flat amount the partner wants to receive, the final amount to be paid will be visible at the gate and depends on the operator `net` - net amount `gross` - gross amount
description	string <= 128 Description of the transaction visible at the payment gate
control	string <= 128 Parameter for use by the partner to identify the transaction
	object URLs to redirect the client after the transaction
phoneNumber	string Enforced phone number
steamid	string <steamId64> Optional field (steamid64)

Responses

Request samples

Payload

Content type

application/json

Example

directbillingTransactionCreateAll

{"amount": 19.99,
"amountType": "gross",
"description": "Payment for virtual products",
"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"
}
}

Retrieve Transaction Information

Authorizations:

bearerAuth

path Parameters

serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Service ID
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"
}
}

Online Payments

Signature

Calculating the signature for receiving notifications

Generate the signature by concatenating all received parameters (except signature) in the order from the available table above, separating them with a separator |, and adding the key available in the client panel for the service at the end.
Hashing must be done using sha256.
Example:
dc261d4f-31ef-4728-bfd6-97bbe2a5ef0a|e14f8074|transaction_paid|10|PLN|9.9|88643ada8857f25a1f391395f922f7db|blik|production|key

Receiving transaction information 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}$ Service ID
status required	string (paymentTransactionStatus) Enum: "transaction_new" "transaction_confirmed" "transaction_generated" "transaction_paid" "transaction_failed" "transaction_expired" "transaction_canceled" Transaction status
required	object Billing object
control	string Field for use by the partner
channel required	string Payment channel
environment required	string Enum: "production" "test"
signature required	string Signature of the notification Read how to generate the signature The partner is required to verify the signature upon receiving the notification. You can also make a request to the endpoint Retrieve transaction details

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

Retrieve Service List

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

Retrieve Service Details

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

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

Retrieve List of Channels for the Service

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

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
}
}
]
}

Retrieve Transaction List

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

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

Generate Transaction

Authorizations:

bearerAuth

path Parameters

serviceId

required

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

Service ID

Request Body schema: application/json

amount required	number <float> >= 1 Transaction amount
currency	string Default: "PLN" Transaction currency
description	string <= 64 characters Description of the transaction provided by the partner, displayed on the payment gateway
control	string <= 255 characters Field for use by the partner
	object or null Basic information about the payer
	object or null (paymentCustomerFull)
	object or null (paymentCustomerFull)
	Array of objects or null (paymentCartItem)
	object or null
directChannel	string In this field, you can send the channel ID, and the payer will be redirected directly to the specified channel e.g., when specifying `blik`, they will be redirected directly to the BLIK payment gateway
channels	Array of strings or null Array of payment channel IDs that will be displayed to the payer at the gateway after being redirected to the transaction URL The list of available channels and their IDs can be obtained here Retrieve list of channels for the service
	object or null Object in which we can define which types of channels should be available at the payment gateway
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]"
},
"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"
}
}

Retrieve Transaction Details

Authorizations:

bearerAuth

path Parameters

serviceId required	string (ServiceId) = 8 characters ^[0-9a-f]{8}$ Service ID
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

Service List

Authorizations:

Responses

Response samples

Retrieve Service Information

Authorizations:

path Parameters

Responses

Response samples

Verify Code Validity

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve Transaction List

Authorizations:

path Parameters

Responses

Response samples

Retrieve Transaction Information

Authorizations:

path Parameters

Responses

Response samples

Retrieve Service Numbers Information

Authorizations:

path Parameters

Responses

Response samples

Retrieve Service Number Information

Authorizations:

path Parameters

Responses

Response samples

Retrieve All Available Numbers

Authorizations:

Responses

Response samples

Retrieve Number Information

Authorizations:

path Parameters

Responses

Response samples

DirectBilling

Signature

Calculating the signature for receiving notifications

Receiving transaction information Webhook

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve Service List

Authorizations:

Responses

Response samples

Retrieve Service Information

Authorizations:

path Parameters

Responses

Response samples

Calculate Commission

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Retrieve Transaction List

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Generate Transaction

Authorizations:

path Parameters

Request Body schema: application/json

Request Body schema: application/json
required