Get Refunds

Returns all or specific refunds of the order.

Path

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

Request Parameters

orderNumber

required

string

Order number

refundNumber

required

string

Refund number

Responses

array

Collection of refunds

reservationId

string

Reservation ID

customerNumber

string

Max length: 100

Customer number

refundNumber

string

Max length: 50

Refund number

orderNumber

string

Max length: 50

Order number

amount

number

Refunded amount

balance

number

Remaining amount to be refunded

currency

string

Enum:

EUR

NOK

SEK

DKK

CHF

Currency

insertedAt

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Indicates the Refund creation time

updatedAt

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Indicates the time when the refund was last updated

captureNumber

string

Max length: 50

Capture number

array

Refund items

productId

required

string

Max length: 100

Merchant Product identification number.

groupId

string

Max length: 255

Item group ID. The group this item belongs to. Provided by the merchant. Everything over 255 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:

PhysicalArticle

DigitalArticle

GiftCard

Discount

ShippingFee

Surcharge

Info

Subscription

netUnitPrice

required

number

Net unit price.

grossUnitPrice

required

number

Gross price per item.

quantity

required

number

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

unitCode

string

Max length: 50

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

vatCategory

string

Enum:

HighCategory

LowCategory

NullCategory

NoCategory

MiddleCategory

OtherCategory

Vat category

vatPercent

required

number

Tax percent.

vatAmount

required

number

Tax amount per item.

imageUrl

string

Max length: 2048

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. Supported image formats are: gif, jpeg (jpg), png, webp.

googleProductCategoryId

integer

Google product category ID.

googleProductCategory

string

Max length: 255

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

Max length: 255

Categorization used by Merchant as a complement to Google Taxonomy.

lineNumber

integer

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

productUrl

string

Max length: 2048

URL to the product.

marketPlaceSellerId

string

Max length: 32

ID of an individual seller on a marketplace. If this field is used, an entry in the element additionalData -> marketplace must also be provided.

parentTransactionReference

string

Max length: 128

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

additionalInformation

string

Max length: 4096

Extended description of the order item.

specification

N/A

Specification.

serviceStart

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Capture start time.

serviceEnd

string

yyyy-MM-ddTHH:mm:ss.fffffffzzz

Capture end time.

parentTransactionReference

string

Max length: 128

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

transactionReference

string

Max length: 100

Transaction-specific reference from and for the PSP's system

Successful Request

Unsuccessful Request, Incorrect Refund Number

Request Example

    
        null

Response Example

    
        {
 "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
    }
   ]
  }
 ]
}

Request Example

    
        null

Response Example

    
        [
 {
  "type": "BusinessError",
  "code": "400.133",
  "message": "Refund not found.",
  "customerFacingMessage": "Refund not found.",
  "actionCode": "Unavailable",
  "fieldReference": ""
 }
]