Skip to content
/
Retrieving a list of chan...

simpay-api (1.0.0)

Polish version

Download OpenAPI description
index.json
index.yaml
Overview
URL

https://simpay.pl/kontakt

Support

kontakt@simpay.pl

Terms of Service

Languages
Servers
Mock server

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

https://api.simpay.pl/

SMS

Operations

DirectBilling

OperationsWebhooks

Online Payments

Operations

Retrieving service details

Request

Security
bearerAuth
Path
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

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

Responses

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataobjectrequired
Example: {"id":"d151e4f9","name":"Test service","status":"service_active","created_at":"2021-11-08T18:19:16+01:00"}
data.​idstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

data.​namestringrequired

Service name

Example: "Test service"
data.​statusstring(ServiceStatus)required

Service Status

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

Creation date in format: ISO 8601

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

Retrieving a list of channels for the service

Request

Security
bearerAuth
Path
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

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

Responses

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataArray of objectsrequired
Example: [{"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[].​idstringrequired

Payment channel ID

data[].​namestringrequired

Channel name

data[].​typestringrequired

Channel type

data[].​imgstring(url)required

URL to the payment channel graphic

data[].​commissionnumber(float)required

Commission charged by SimPay from the payment

data[].​currenciesArray of stringsrequired

Array of available currencies

data[].​amountobjectrequired

Amounts available for the channel

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

Minimum payment amount

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

Maximum payment amount

Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … }
  ]
}

Retrieving a list of transactions

Request

Security
bearerAuth
Path
serviceIdstring(ServiceId)= 8 characters^[0-9a-f]{8}$required

Service ID

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

Responses

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataArray of objectsrequired
Example: [{"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"}]
data[].​idstring(uuid)(TransactionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...required

Transaction ID

data[].​statusstring(paymentTransactionStatus)required

Transaction status

Enum"transaction_new""transaction_confirmed""transaction_generated""transaction_paid""transaction_failure""transaction_expired""transaction_canceled""transaction_refunded""transaction_fraud""transaction_fraud_possibility"
data[].​amountnumber(float)required
data[].​controlstringrequired
data[].​channelstringrequired
data[].​paid_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

data[].​created_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

data[].​updated_atstring(date-time)(DateTime)required

Creation date in format: ISO 8601

paginationobject(Pagination)required
pagination.​totalintegerrequired

Total number of records

Example: 1
pagination.​countintegerrequired

Number of records on the current page

Example: 1
pagination.​per_pageintegerrequired

Maximum number of records per page

Example: 15
pagination.​current_pageintegerrequired

Current page

Example: 1
pagination.​total_pagesintegerrequired

Total number of pages

Example: 1
pagination.​linksobjectrequired

URLs to pages

pagination.​links.​next_pagestring or null(url)required

URL to the next page

Example: null
pagination.​links.​prev_pagestring or null(url)required

URL to the previous page

Example: null
Response
application/json
{
  "success": true,
  "data": [
    { … },
    { … }
  ],
  "pagination": {
    "total": 2,
    "count": 2,
    "per_page": 15,
    "current_page": 1,
    "total_pages": 1,
    "links": { … }
  }
}
© 2025 Payments Solution Sp. z o.o. - All rights reserved.