Skip to main content

Refund Validation Request

typestringrequired

Product type. Must be set to PAYSAFECARD.

Possible values: [PAYSAFECARD]

Example: PAYSAFECARD
capturebooleanrequired

Set to false to validate the refund without executing it.

Possible values: [false, true]

Example: false
amountnumber<double>required

Refund amount, with up to 11 digits before and up to two digits after the decimal point.

Possible values: >= 0.01

Example: 10
currencystringrequired

Three-letter ISO 4217 currency code.

Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

Example: EUR
customer objectrequired
anyOf
submerchant_idstring

Sub-merchant identifier, also known as the reporting criterion. Required for payment service providers.

Possible values: <= 8 characters, Value must match regular expression ^[A-Za-z0-9]+$

Example: RCxD1234
commentstring

Reason for the refund request.

Possible values: <= 60 characters

Example: Non-Wagered Funds
languagestring

ISO 639-1 alpha-2 language code used for a pending-refund account-creation email.

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: DE
country_codestring

ISO 3166-1 alpha-2 country code for the account created to receive refund funds.

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: AT
notification_urlstring<uri>

URL that receives pending-refund creation and completion notifications.

Example: https://pendingrefundnotification.com
Refund Validation Request
{
"type": "PAYSAFECARD",
"capture": false,
"amount": 10,
"currency": "EUR",
"submerchant_id": "RCxD1234",
"comment": "Non-Wagered Funds",
"language": "DE",
"country_code": "AT",
"notification_url": "https://pendingrefundnotification.com"
}