Home
HomeGuidesAPI ReferenceChangelogPOS PaymentsOnline Payments
Home
API Reference

Create Riverty refund

post
https://example.com/api/v1/paymentmethods/riverty/v1/transactions//refunds

Create a refund for a specific capture within an existing Riverty transaction.

The captureId field is required for transactions with multiple captures, and optional for transactions with a single capture.

The items field is optional. If omitted, all items of the capture will be refunded.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
length between 36 and 36

ID received in the POST transaction response root object, which can be used in up following calls like refunds or cancellations as transactionId.

Body Params
uuid
length between 36 and 36

Unique identifier of the capture to be refunded, received in the capture response.

Required for transactions with multiple captures.

string
length ≤ 255

The description for the refund for administrative purpose only. This reason will be visible in the portal.

items
array of objects
length between 1 and 500

Array of order items. Maximum allowed 500 items.

items
string
required
length between 1 and 50

Merchant Product identification. Each item code must be unique per transaction.

string
required
length ≤ 255

Description of the underlying value or reason of the payment.

integer
required
1 to 99999999

Denomination in the smallest currency subunit, as for example euro cents.

integer
required
1 to 1000000000

The number of items of this type.

integer
required
1 to 99999999

Denomination in the smallest currency subunit, as for example euro cents.

number
required
0 to 99.9

Percentage of VAT applied.
Only the first decimal value will be taken into account, the rest will be ignored.

integer
required
1 to 99999999

Denomination in the smallest currency subunit, as for example euro cents.

url

URL for the product image, will be used as a thumbnail in Riverty on the invoice line. Must be rectangular or square with a width between 100-1280 pixels. Supported formats, gif, jpeg(jpg), png, webp

url

URL to the product page

Responses

Updated about 1 month ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago