Skip to content
/
Retrieve a list of refund...

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 transaction details

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}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
successbooleanrequired

Request status

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

Transaction ID

data.​payer_transaction_idstringrequired

Transaction identifier shared with the payer

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

Payment amount in the buyer's currency

Example: 7.55
data.​amount.​currencystring(ISO-4217)required

Buyer's currency

Example: "BRL"
data.​amount.​commissionnumber or null(float)required

SimPay's commission amount

Example: 0.12
data.​amount.​commission_currencystring(ISO-4217)required

Commission currency (PLN/EUR)

Example: "EUR"
data.​amount.​originalobject

Original amounts declared at initiation

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

Postal code, format depends on the country field

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

Country

data.​billing.​companystring or null

Company name

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

Postal code, format depends on the country field

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

Country

data.​shipping.​companystring or null

Company name

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

Product name

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

Quantity of the product

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

Price of one product

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

Product brand

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

Product category

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

Product code

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

Creation date in format: ISO 8601

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

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

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"
  }
}
© 2025 Payments Solution Sp. z o.o. - All rights reserved.