Capture a payment

post

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

Path Params

paymentId

uuid

required

The id of the payment transaction

Body Params

merchantTransactionId

string

length between 1 and 64

^[\p{L}0-9 .,'"%€_°&()+/#:-]+$

A human-readable reference string from the merchant to identify a transaction.

merchantTransactionDescription

string

length between 1 and 128

^[\p{L}0-9 .,'"%€_°&()+/#:-]+$

A description text for a transaction, provided by the merchant. Description is shown to the customer as part of the remittance information of the bank transaction. For usage in the remittance information the value is truncated by EPI to a maximum of 74 characters.

payment

object

required

finalCapture

boolean

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 of payment capture

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.