Make a refund for an existing payment

post

https://vrp-epi-payment-service-test.public.stg.vrpintegration.dev/tsp/api/v1/payments/{paymentId}/refunds

Path Params

paymentId

uuid

required

The id of the payment transaction

Body Params

captureId

uuid

required

The identifier of the resource

payment

object

required

refundReason

string

enum

Allowed:

transactionDescription

string

length between 1 and 255

^[a-zA-Z0-9\/?:().,'+\-\s]+$

Information provided by the merchant to the customer as part of a refund. This description is shown to the customer as part of the remittance information of the bank transaction.
Only characters from the SEPA character set are permitted: letters (a–z, A–Z), digits (0–9), and the symbols / ? : ( ) . , ' + - as well as whitespace.
For usage in the remittance information the value is truncated by EPI to a maximum of 24 characters.
If not provided, the default text "Refund for your purchase on ${consent_date}" will be used.

Headers

merchantId

string

required

length between 10 and 10

^\d{10}$

The id of the merchant account.

shopId

string

length between 6 and 6

^\d{6}$

The ID of the referenced shop.
As long as the given merchant has only one shop, shopId can be omitted, because the only available shop will be picked automatically.
As soon as the given merchant has has more than one shop, shopId is mandatory. Otherwise, 409 Conflict is returned.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

201The response from a refund

400Response made to return bad request information.

404Response made to return not found information.

422An error as described by the Error object caused by validation/unprocessable entity

500An error as described by the Error object.