Przejdź do treści
Referencja API
/
/
Pobieranie listy transakc...

simpay-api (1.0.0)

English version

Pobierz opis OpenAPI
index.json
index.yaml
Przegląd
URL

https://simpay.pl/kontakt

Support

kontakt@simpay.pl

Warunki świadczenia usług

Języki
Serwery
Mock server

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

https://api.simpay.pl/

SMS

Operacje

DirectBilling

OperacjeWebhooki

Płatności online

Operacje

Pobieranie listy kanałów 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/payment/{serviceId}/channels' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objectswymagany
Przykład: [{"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[].​idstringwymagany

Id kanału płatności

data[].​namestringwymagany

Nazwa kanału

data[].​typestringwymagany

Typ kanału

data[].​imgstring(url)wymagany

Adres URL do grafiki kanału płatności

data[].​commissionnumber(float)wymagany

Prowizja pobierana przez SimPay z płatności

data[].​currenciesArray of stringswymagany

Tablica z dostępnymi walutami

data[].​amountobjectwymagany

Kwoty dostępne dla kanłu

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

Kwota minimalna do płatności

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

Kwota maksymalna do płatności

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

Pobieranie listy transakcji

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objectswymagany
Przykład: [{"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]...wymagany

Id transakcji

data[].​statusstring(paymentTransactionStatus)wymagany

Status transakcji

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)wymagany
data[].​controlstringwymagany
data[].​channelstringwymagany
data[].​paid_atstring(date-time)(DateTime)wymagany

Data utworzenia w formacie: ISO 8601

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

Data utworzenia w formacie: ISO 8601

data[].​updated_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": 2,
    "count": 2,
    "per_page": 15,
    "current_page": 1,
    "total_pages": 1,
    "links": { … }
  }
}

Generowanie transakcji

Żądanie

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

Id usługi

Treśćapplication/json
amountnumber(float)>= 1wymagany

Kwota transakcji

currencystring

Waluta transakcji

Domyślny "PLN"
descriptionstring<= 64 characters

Opis transakcji nadany przez partnera, prezentowany na bramce płatności

controlstring<= 255 characters

Pole do wykorzystania przez partnera

customerobject or null

Obiekt podstawowych informacji o płacącym

antifraudobject or null

Obiekt informacji do antifrauda

billingobject or null(paymentCustomerFull)
shippingobject or null(paymentCustomerFull)
cartArray of objects or null(paymentCartItem)
returnsobject or null
directChannelstring

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.

channelsArray 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

channelTypesobject or null

Obiekt w którym możemy zdefiniować które typu kanłów mają być dostępne na bramce płatności

refererstring[ 6 .. 64 ] characters
curl -i -X POST \
  'https://docs.simpay.pl/_mock/apis/payment/{serviceId}/transactions' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": 1,
    "currency": "PLN",
    "description": "string",
    "control": "string",
    "customer": {
      "name": "string",
      "email": "user@example.com",
      "ip": "string",
      "countryCode": "PL"
    },
    "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,
      "paysafe": true,
      "latam": true
    },
    "referer": "string"
  }'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataobjectwymagany
Przykład: {"transactionId":"1d87a1b3-18f8-4146-bcb1-c0c9f293b04f","redirectUrl":"https://pay.simpay.pl/1d87a1b3-18f8-4146-bcb1-c0c9f293b04f"}
data.​transactionIdstring(uuid)(TransactionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...wymagany

Id transakcji

data.​redirectUrlstring(url)wymagany
Przykład: "https://pay.simpay.pl/1d87a1b3-18f8-4146-bcb1-c0c9f293b04f"
Odpowiedź
application/json
{
  "success": true,
  "data": {
    "transactionId": "1d87a1b3-18f8-4146-bcb1-c0c9f293b04f",
    "redirectUrl": "https://pay.simpay.pl/1d87a1b3-18f8-4146-bcb1-c0c9f293b04f"
  }
}
© 2025 Payments Solution Sp. z o.o. - All rights reserved.