Przejdź do treści
Referencja API
/
/
Utworzenie zwrotu dla tra...

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 zwrotów dla 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}/refunds' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataArray of objectswymagany
Przykład: [{"id":"019483a5-885e-70f7-9b5b-94387a6690da","status":"refund_completed","amount":1,"currency":"PLN","wallet_amount":1,"wallet_currency":"PLN","created_at":"2025-01-20T13:17:31+01:00","updated_at":"2025-01-20T13:17:59+01:00"}]
data[].​idstring(uuid)(RefundId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...wymagany

Id zwrotu

data[].​statusstring(paymentTransactionRefundStatus)wymagany

Status zwrotu

Enum"refund_new""refund_pending""refund_completed""refund_rejected""refund_failed"
data[].​amountnumber(float)wymagany

Kwota zwrotu w walucie płacącego

data[].​currencystring= 3 characterswymagany

Waluta płacącego

data[].​wallet_amountnumber(float)wymagany

Kwota zwrotu pobrana z portfela

data[].​wallet_currencystring= 3 characterswymagany

Waluta portfela

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": [
    { … }
  ]
}

Utworzenie zwrotu dla 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 POST \
  'https://docs.simpay.pl/_mock/apis/payment/{serviceId}/transactions/{transactionId}/refunds' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataobjectwymagany
Przykład: {"refund_id":"019483a5-885e-70f7-9b5b-94387a6690da"}
data.​refund_idstring(uuid)(RefundId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...wymagany

Id zwrotu

Odpowiedź
application/json
{
  "success": true,
  "data": {
    "refund_id": "019483a5-885e-70f7-9b5b-94387a6690da"
  }
}

Pobieranie pojedynczego zwrotu 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

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

Id zwrotu

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

Odpowiedzi

Treśćapplication/json
successbooleanwymagany

Request status

Przykład: true
dataobjectwymagany
Przykład: {"id":"019483a5-885e-70f7-9b5b-94387a6690da","status":"refund_completed","amount":1,"currency":"PLN","wallet_amount":1,"wallet_currency":"PLN","created_at":"2025-01-20T13:17:31+01:00","updated_at":"2025-01-20T13:17:59+01:00"}
data.​idstring(uuid)(RefundId)= 36 characters^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]...wymagany

Id zwrotu

data.​statusstring(paymentTransactionRefundStatus)wymagany

Status zwrotu

Enum"refund_new""refund_pending""refund_completed""refund_rejected""refund_failed"
data.​amountnumber(float)wymagany

Kwota zwrotu w walucie płacącego

Przykład: 1
data.​currencystring= 3 characterswymagany

Waluta płacącego

Przykład: "PLN"
data.​wallet_amountnumber(float)wymagany

Kwota zwrotu pobrana z portfela

Przykład: 1
data.​wallet_currencystring= 3 characterswymagany

Waluta portfela

Przykład: "PLN"
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": "019483a5-885e-70f7-9b5b-94387a6690da",
    "status": "refund_completed",
    "amount": 1,
    "currency": "PLN",
    "wallet_amount": 1,
    "wallet_currency": "PLN",
    "created_at": "2025-01-20T13:17:31+01:00",
    "updated_at": "2025-01-20T13:17:59+01:00"
  }
}
© 2025 Payments Solution Sp. z o.o. - All rights reserved.