Skip to content
/
Create a refund for a tra...

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

Retrieve a list of refunds for a transaction

Request

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

Service ID

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

Transaction ID

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

Responses

Bodyapplication/json
successbooleanrequired

Request status

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

Refund ID

data[].​statusstring(paymentTransactionRefundStatus)required

Refund status

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

Refund amount in the payer's currency

data[].​currencystring= 3 charactersrequired

Payer's currency

data[].​wallet_amountnumber(float)required

Refund amount deducted from the wallet

data[].​wallet_currencystring= 3 charactersrequired

Wallet currency

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

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

Create a refund for a transaction

Request

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

Service ID

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

Transaction ID

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

Responses

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataobjectrequired
Example: {"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]...required

Refund ID

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

Retrieve a single refund within a transaction

Request

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

Service ID

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

Transaction ID

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

Refund ID

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

Responses

Bodyapplication/json
successbooleanrequired

Request status

Example: true
dataobjectrequired
Example: {"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]...required

Refund ID

data.​statusstring(paymentTransactionRefundStatus)required

Refund status

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

Refund amount in the payer's currency

Example: 1
data.​currencystring= 3 charactersrequired

Payer's currency

Example: "PLN"
data.​wallet_amountnumber(float)required

Refund amount deducted from the wallet

Example: 1
data.​wallet_currencystring= 3 charactersrequired

Wallet currency

Example: "PLN"
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

Response
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.