BNPL Payment MethodsRecurring PaymentsAccounting as a Service

Get Refunds

Returns all or specific refunds of the order.

Path

GET /api/v3/orders/{orderNumber}/refunds/{refundNumber}

Request Parameters

Paramater Description
orderNumber Order number
refundNumber Refund number

Responses

200 Success

RESPONSE SCHEMA:

refunds

array

Collection of refunds
Array () [
reservationId

string uuid

Reservation ID
customerNumber

string

Customer number
refundNumber

string

Refund number
orderNumber

string

Order number
amount

number double

Refunded amount
balance

number double

Remaining amount to be refunded
currency

string

Enum:EURNOKSEKDKKCHF

Currency
insertedAt

string date-time

Indicates the Refund creation time
updatedAt

string date-time

Indicates the time when the refund was last updated
captureNumber

string

Capture number
refundItems

array

Refund items
Array () [
productId
required

string

Merchant Product identification number.
groupId

string

Item group ID. The group this item belongs to. Provided by the merchant. Everything over 50 characters will be truncated.
description
required

string

Product name. For example "Black music player 64GB". Everything over 255 characters will be truncated.
type

string

Enum:PhysicalArticleDigitalArticleGiftCardDiscountShippingFeeSurchargeInfoSubscription
netUnitPrice
required

number double

Net unit price.
grossUnitPrice
required

number double

Gross price per item.
quantity
required

number double

Quantity. Use of integer is strongly proposed. If you want to use decimal, please contact your integration manager.
unitCode

string

Unit code (for example pieces, liters, kilograms, etc.).
vatCategory

string

Enum:HighCategoryLowCategoryNullCategoryNoCategoryMiddleCategoryOtherCategory

Vat category
vatPercent
required

number double

Tax percent.
vatAmount
required

number double

Tax amount per item.
imageUrl

string

URL for the image of this product. It will be turned into a thumbnail and displayed in Riverty, on the invoice line next to the order item. The linked image must be a rectangle or square, width between 100 pixels and 1280 pixels.
googleProductCategoryId

integer int32

Google product category ID.
googleProductCategory

string

Indicates the category of the item based on the Google product taxonomy. Categorizing the product helps ensure that the ad is shown with the right search results.
merchantProductType

string

Categorization used by Merchant as a complement to Google Taxonomy.
lineNumber

integer int32

Line number. The merchant may add a line number to each order item, to sort them in a particular order.
productUrl

string

URL to the product.
marketPlaceSellerId

string

ID of an individual seller on a marketplace.
parentTransactionReference

string

A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
additionalInformation

string

Extended description of the order item.
specification

undefined

Specification.
serviceStart

string date-time

Capture start time.
serviceEnd

string date-time

Capture end time.
]
parentTransactionReference

string

A unique reference provided to Riverty by a third party (merchant or Payment Service Provider). Identifies an entire order.
transactionReference

string

Transaction-specific reference from and for the PSP's system
]
400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage
code

string

Confirmation or error code
message

string

Message content
customerFacingMessage

string

Message to display to customer
actionCode

string

Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify

Action codes
fieldReference

string

Reference to field that caused an error
]
401 Authorization has been denied for this request.

RESPONSE SCHEMA:

type

string

title

string

status

integer int32

detail

string

instance

string

429 Too many requests.

RESPONSE SCHEMA:

type

string

title

string

status

integer int32

detail

string

instance

string

Request

Please select an example:

Response

{
  "refunds": [
    {
      "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
      "reservationId": "fb583567-c5a1-45de-a341-289c75e3f3dd",
      "customerNumber": "AP000100919",
      "refundNumber": "800090090",
      "orderNumber": "riverty1",
      "amount": -185,
      "balance": -185,
      "currency": "EUR",
      "insertedAt": "2023-09-27T12:24:53Z",
      "captureNumber": "800090089",
      "refundItems": [
        {
          "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
          "productId": "4534-BLK-M",
          "groupId": "",
          "description": "Leather jacket, Black, size M",
          "netUnitPrice": -84,
          "grossUnitPrice": -100,
          "quantity": 1,
          "vatPercent": 19,
          "vatAmount": -16,
          "imageUrl": "https://developer-sandbox.riverty.com/images/black_leather_jacket.jpg"
        },
        {
          "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
          "productId": "5745-GRY-M",
          "groupId": "",
          "description": "Socks, Grey, Size M",
          "netUnitPrice": -8.4,
          "grossUnitPrice": -10,
          "quantity": 5,
          "vatPercent": 19,
          "vatAmount": -1.6,
          "imageUrl": "https://developer-sandbox.riverty.com/images/grey_socks.jpg"
        },
        {
          "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
          "productId": "3323-BRN-M",
          "groupId": "",
          "description": "Woolen hat, brown, Size M",
          "netUnitPrice": -25.21,
          "grossUnitPrice": -30,
          "quantity": 1,
          "vatPercent": 19,
          "vatAmount": -4.79,
          "imageUrl": "https://developer-sandbox.riverty.com/images/brown_wool_hat.jpg"
        },
        {
          "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
          "productId": "SHIP",
          "groupId": "",
          "description": "Shipping",
          "type": "ShippingFee",
          "netUnitPrice": -4.2,
          "grossUnitPrice": -5,
          "quantity": 1,
          "vatPercent": 19,
          "vatAmount": -0.8
        }
      ]
    }
  ]
}