Przejdź do treści
Referencja API
/
/
Generowanie transakcji

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

Pobieranie szczegółów transakcji

Żądanie

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

Id usługi

transactionIdstring(uuid)(TransactionId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...wymagany

Id transakcji

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataobjectwymagany
Przykład: {"id":"328bd42d-d08b-43f6-9463-869e5bd32b4","payer_transaction_id":"477YDX14","status":"transaction_paid","amount":{"value":7.55,"currency":"BRL","commission":0.12,"commission_currency":"EUR","original":{"value":5,"currency":"PLN","pln_rate":1}},"channel":"nest","control":null,"description":null,"redirect":{"success":null,"failure":null},"customer":{"name":null,"email":"kontakt@simpay.pl","ip":"192.168.0.1","country":"PL"},"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":"2023-12-07T05:20:30+01:00","updated_at":"2023-12-07T05: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.​payer_transaction_idstringwymagany

Identyfikator transakcji udostępniony płacącemu

Przykład: "477YDX14"
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.​amountobjectwymagany
Przykład: {"value":7.55,"currency":"BRL","commission":0.12,"commission_currency":"EUR","original":{"value":5,"currency":"PLN","pln_rate":1}}
data.​amount.​valuenumber(float)wymagany

Kwota płatności w walucie kupującego

Przykład: 7.55
data.​amount.​currencystring(ISO-4217)wymagany

Waluta kupującego

Przykład: "BRL"
data.​amount.​commissionnumber or null(float)wymagany

Kwota prowizji dla SimPay

Przykład: 0.12
data.​amount.​commission_currencystring(ISO-4217)wymagany

Waluta prowizji (PLN/EUR)

Przykład: "EUR"
data.​amount.​originalobject

Oryginalne kwoty zadeklarowane przy inicjacji

Przykład: {"value":5,"currency":"PLN","pln_rate":1}
data.​channelstring or nullwymagany
Przykład: "nest"
data.​controlstring or nullwymagany
data.​descriptionstring or nullwymagany
data.​redirectobjectwymagany
Przykład: {"success":null,"failure":null}
data.​redirect.​successstring or null(url)wymagany
data.​redirect.​failurestring or null(url)wymagany
data.​customerobjectwymagany
Przykład: {"name":null,"email":"kontakt@simpay.pl","ip":"192.168.0.1","country":"PL"}
data.​customer.​namestring or nullwymagany
data.​customer.​emailstring or null(email)wymagany
Przykład: "kontakt@simpay.pl"
data.​customer.​ipstring or null(ip)
Przykład: "192.168.0.1"
data.​customer.​countrystring or null(CountryCode)
Przykład: "PL"
data.​billingobject or null(paymentCustomerFull)wymagany
data.​billing.​namestring or null[ 5 .. 64 ] characterswymagany
data.​billing.​surnamestring or null<= 64 characterswymagany
data.​billing.​streetstring or null<= 64 characterswymagany
data.​billing.​buildingstring or null<= 16 characters
data.​billing.​flatstring or null<= 16 characters
data.​billing.​citystring or null<= 32 characterswymagany
data.​billing.​regionstring or null<= 32 characters
data.​billing.​postalCodestring or nullwymagany

Kod pocztowy, format zależny od pola country

data.​billing.​countrystring or null(ISO 3166-1 alpha-2)wymagany

Kraj

data.​billing.​companystring or null

Nazwa firmy

data.​shippingobject or null(paymentCustomerFull)wymagany
data.​shipping.​namestring or null[ 5 .. 64 ] characterswymagany
data.​shipping.​surnamestring or null<= 64 characterswymagany
data.​shipping.​streetstring or null<= 64 characterswymagany
data.​shipping.​buildingstring or null<= 16 characters
data.​shipping.​flatstring or null<= 16 characters
data.​shipping.​citystring or null<= 32 characterswymagany
data.​shipping.​regionstring or null<= 32 characters
data.​shipping.​postalCodestring or nullwymagany

Kod pocztowy, format zależny od pola country

data.​shipping.​countrystring or null(ISO 3166-1 alpha-2)wymagany

Kraj

data.​shipping.​companystring or null

Nazwa firmy

data.​cartArray of objects or null(paymentCartItem)wymagany
data.​cart[].​namestring[ 3 .. 64 ] characterswymagany

Nazwa produktu

data.​cart[].​quantitynumber(integer)>= 1wymagany

Ilość danego produktu

data.​cart[].​pricenumber(float)>= 0.01wymagany

Kwota jednego produktu

data.​cart[].​producerstring or null<= 64 characterswymagany

Marka producneta produktu

data.​cart[].​categorystring or null<= 64 characterswymagany

Kategoria produktu

data.​cart[].​codestring or null<= 64 characterswymagany

Kod produktu

data.​paid_atstring(date-time)(DateTime)wymagany

Data utworzenia w formacie: ISO 8601

data.​expires_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

Odpowiedź
application/json
{
  "success": true,
  "data": {
    "id": "328bd42d-d08b-43f6-9463-869e5bd32b4",
    "payer_transaction_id": "477YDX14",
    "status": "transaction_paid",
    "amount": { … },
    "channel": "nest",
    "control": null,
    "description": null,
    "redirect": { … },
    "customer": { … },
    "billing": { … },
    "shipping": { … },
    "cart": null,
    "paid_at": "2023-12-07T05:21:50+01:00",
    "expires_at": null,
    "created_at": "2023-12-07T05:20:30+01:00",
    "updated_at": "2023-12-07T05:21:50+01:00"
  }
}
© 2025 Payments Solution Sp. z o.o. - All rights reserved.