Przelewy24 · Schema

TransferP24RefundObject

PaymentsPayment GatewayBank TransferBLIKCard PaymentsE-CommercePolandPolishMulti-CurrencyFintech

Properties

Name Type Description
sessionId string Session ID in Przelewy24 system
title string Title of refund transaction
currency string Currency in which refund will be executed as ISO 4217 code (currently available: EUR, PLN)
amount integer Amount of created refund in smallest denomination
Example: "100" (1 PLN)
overrefund boolean If TRUE, refund will be executed no matter if there was any other refunds executed for this transaction earlier. It ignores error 2010.
Default value is FALSE
View JSON Schema on GitHub

JSON Schema

TransferP24RefundObject.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "TransferP24RefundObject",
  "properties": {
    "sessionId": {
      "type": "string",
      "maxLength": 255,
      "description": "Session ID in Przelewy24 system"
    },
    "title": {
      "type": "string",
      "maxLength": 255,
      "description": "Title of refund transaction"
    },
    "currency": {
      "type": "string",
      "maxLength": 3,
      "description": "Currency in which refund will be executed as ISO 4217 code (currently available: EUR, PLN)"
    },
    "amount": {
      "type": "integer",
      "description": "Amount  of  created  refund  in  smallest denomination<br/> Example: \"100\" (1 PLN)"
    },
    "overrefund": {
      "type": "boolean",
      "default": false,
      "description": "If  TRUE,  refund  will  be  executed <b>no matter if there was any other refunds executed for this transaction earlier</b>. It ignores error 2010.<br/><b>Default value is FALSE</b>"
    }
  },
  "required": [
    "sessionId",
    "title",
    "currency",
    "amount"
  ]
}