# simpay-api

[Polish version](/apis)

Version: 1.0.0

## Servers

```
https://api.simpay.pl
```

## Security

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[simpay-api](https://docs.simpay.pl/_bundle/@l10n/en/apis/index.yaml)

## SMS

### Service list

 - [GET /sms](https://docs.simpay.pl/en/apis/sms/smsservicelist.md): Retrieving a list of available SMS services on the account

### Retrieving service information

 - [GET /sms/{serviceId}](https://docs.simpay.pl/en/apis/sms/smsserviceshow.md)

### Verifying code correctness

 - [POST /sms/{serviceId}](https://docs.simpay.pl/en/apis/sms/smsservicecheckcode.md)

### Retrieving a list of transactions

 - [GET /sms/{serviceId}/transactions](https://docs.simpay.pl/en/apis/sms/smstransactionslist.md)

### Retrieving transaction information

 - [GET /sms/{serviceId}/transactions/{transactionId}](https://docs.simpay.pl/en/apis/sms/smstransactionsshow.md)

### Retrieving information about numbers for the service

 - [GET /sms/{serviceId}/numbers](https://docs.simpay.pl/en/apis/sms/smsservicenumbers.md)

### Retrieving information about the number for the service

 - [GET /sms/{serviceId}/numbers/{number}](https://docs.simpay.pl/en/apis/sms/smsservicenumber.md)

### Retrieving all available numbers

 - [GET /sms/numbers](https://docs.simpay.pl/en/apis/sms/smsnumbers.md)

### Retrieving a number

 - [GET /sms/numbers/{number}](https://docs.simpay.pl/en/apis/sms/smsnumber.md)

## DirectBilling

### Retrieving a list of services

 - [GET /directbilling](https://docs.simpay.pl/en/apis/directbilling/directbillinggetservices.md)

### Retrieving service information

 - [GET /directbilling/{serviceId}](https://docs.simpay.pl/en/apis/directbilling/directbillingservice.md)

### Commission calculation

 - [GET /directbilling/{serviceId}/calculate](https://docs.simpay.pl/en/apis/directbilling/directbillingservicecalculate.md)

### Retrieving a list of transactions

 - [GET /directbilling/{serviceId}/transactions](https://docs.simpay.pl/en/apis/directbilling/directbillingtransactions.md)

### Generating a transaction

 - [POST /directbilling/{serviceId}/transactions](https://docs.simpay.pl/en/apis/directbilling/directbillingtransactioncreate.md)

### Retrieving transaction information

 - [GET /directbilling/{serviceId}/transactions/{transactionId}](https://docs.simpay.pl/en/apis/directbilling/directbillingtransaction.md)

### Receiving DirectBilling transaction information

 - [POST directbillingTransactionNotification](https://docs.simpay.pl/en/apis/directbilling/directbillingtransactionnotification.md): # Signature

## Calculating the signature when receiving a notification
We generate the signature by combining all the parameters received (except for the signature) to the API in the order from the table above, separating them with a | separator and adding at the end the key available in the customer panel in the service. 
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

The notification is sent using the POST method and requires you to respond in the body with OK and Http Code 200

## Online Payments

### Retrieving a list of services

 - [GET /payment](https://docs.simpay.pl/en/apis/payment/paymentgetservices.md)

### Retrieving service details

 - [GET /payment/{serviceId}](https://docs.simpay.pl/en/apis/payment/paymentgetservice.md)

### Retrieving a list of channels for the service

 - [GET /payment/{serviceId}/channels](https://docs.simpay.pl/en/apis/payment/paymentgetchannels.md)

### Retrieving a list of transactions

 - [GET /payment/{serviceId}/transactions](https://docs.simpay.pl/en/apis/payment/paymentgettransactions.md)

### Generating a transaction

 - [POST /payment/{serviceId}/transactions](https://docs.simpay.pl/en/apis/payment/paymenttransactioncreate.md)

### Retrieving transaction details

 - [GET /payment/{serviceId}/transactions/{transactionId}](https://docs.simpay.pl/en/apis/payment/paymentgettransaction.md)

### Retrieve a list of refunds for a transaction

 - [GET /payment/{serviceId}/transactions/{transactionId}/refunds](https://docs.simpay.pl/en/apis/payment/paymentgettransactionrefunds.md)

### Create a refund for a transaction

 - [POST /payment/{serviceId}/transactions/{transactionId}/refunds](https://docs.simpay.pl/en/apis/payment/paymentmaketransactionrefund.md)

### Retrieve a single refund within a transaction

 - [GET /payment/{serviceId}/transactions/{transactionId}/refunds/{refundId}](https://docs.simpay.pl/en/apis/payment/paymenttransactionrefundshow.md)

### Retrieving a list of currencies for the service

 - [GET /payment/{serviceId}/currencies](https://docs.simpay.pl/en/apis/payment/paymentgetcurrencies.md)

### Provide BLIK code for Level 0 transaction

 - [POST /payment/{serviceId}/blik/level0/{transactionId}](https://docs.simpay.pl/en/apis/payment/paymentbliklevel0.md): See https://docs.simpay.pl/payment/blik-level0 for more information.

### Retrieve subscription list

 - [GET /payment/{serviceId}/subscriptions](https://docs.simpay.pl/en/apis/payment/paymentsubscriptionindex.md): See https://docs.simpay.pl/payment/blik-recurrent for more information.

### Create a subscription

 - [POST /payment/{serviceId}/blik/subscriptions](https://docs.simpay.pl/en/apis/payment/paymentbliksubscriptioncreate.md): See https://docs.simpay.pl/payment/blik-recurrent for more information.

### Execute BLIK Recurring Payment

 - [POST /payment/{serviceId}/blik/subscriptions/{subscriptionId}/autopayment](https://docs.simpay.pl/en/apis/payment/paymentbliksubscriptionexecuteautopayment.md): See https://docs.simpay.pl/payment/blik-recurrent for more information.

### Retrieve list of BLIK aliases

 - [GET /payment/{serviceId}/blik/aliases](https://docs.simpay.pl/en/apis/payment/paymentblikaliasesindex.md)

### Delete/Unregister alias

 - [DELETE /payment/{serviceId}/blik/aliases](https://docs.simpay.pl/en/apis/payment/paymentblikaliasunregister.md): See https://docs.simpay.pl/payment/blik-recurrent for more information.

### Receiving information about online payment transactions

 - [POST paymentTransactionNotification](https://docs.simpay.pl/en/apis/payment/paymenttransactionnotification.md): # Check the link below. You’ll find all the details there:
https://docs.simpay.pl/en/notifications/payment