Riverty Logo
Riverty LogoFor Developers
Riverty Logo
Documentation
API Specification
Partner & Integrations
My Sandbox
FAQ
Home > API > Order Management > Refund

Refund payment

Refund payment

PATH:

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

PATH PARAMETERS:

orderNumber
required

string

Order number

REQUEST BODY SCHEMA:

captureNumber
required

string <= 50 characters

Capture number to refund. This is the capture number which comes from Capture response. Required for Partial Refund

items
required

array of items

Order items to refund. Required for Partial Refund. Maximum allowed 200 items.

Array () [
refundType

string

Enum:RefundReturn

Type of the refund. Please use "Return" for returned items and "Refund" for goodwill refunds

productId
required

string <= 100 characters

Merchant Product identification number.

groupId

string <= 50 characters

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

Order item type.

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 <= 50 characters

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

vatCategory

string

Enum:HighCategoryLowCategoryNullCategoryNoCategoryMiddleCategoryOtherCategory

VAT category.

vatPercent
required

number

Tax percent.

vatAmount
required

number

Tax amount per item.

imageUrl

string <= 2048 characters

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

Google product category ID.

googleProductCategory

string <= 255 characters

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 <= 255 characters

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 <= 2048 characters

URL to the product.

marketPlaceSellerId

string <= 32 characters

ID of an individual seller on a marketplace.

parentTransactionReference

string <= 128 characters

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

additionalInformation

string <= 4096 characters

Extended description of the order item.

specification

object

Specification.

serviceStart

string Format: date-time

Capture start time.

serviceEnd

string Format: date-time

Capture end time.

]
refundType

string

Enum:RefundReturn

Type of the refund. Please use "Return" for returned items and "Refund" for goodwill refunds.

parentTransactionReference

string <= 128 characters

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

transactionReference

string <= 100 characters

A unique reference for each transaction (separate for transactions within an order), generated and provided to Riverty by a third party (merchant or Payment Service Provider). It is used to identify transactions during back-end settlement between Core systems and the PSP.

creditNoteNumber

string <= 19 characters

Credit note number. The merchant may want to use internal credit note numbers, or let the Riverty generate one based on invoice to be credited.

merchantId

string <= 50 characters

Merchant ID within the Riverty system, part of the credentials used for Riverty Netherlands and Belgium. If you were not provided these credentials by your Integration Manager, leave empty.

RESPONSES:

200 OK

RESPONSE SCHEMA:

totalCapturedAmount

number

The total captured amount done with either a full capture, partial capture, or multiple partial captures

totalAuthorizedAmount

number

Total authorized amount

refundNumbers

array

RefundNumber is assigned to an invoice that has been refunded. For one Authorization you can have multiple invoices and refundNumbers

totalRefundedAmount

number

Total refunded amount for this order

remainingAuthorizedAmount

number

Remaining authorized amount

400 Model validation failed.

RESPONSE SCHEMA:

Array () [
type

string

Enum:BusinessErrorTechnicalErrorNotificationMessage

Message type

code

string <= 100 characters

Confirmation or error code

message

string <= 4096 characters

Message content

customerFacingMessage

string <= 4096 characters

Message to display to customer

actionCode

string

Enum:UnavailableAskConsumerToConfirmAskConsumerToReEnterDataOfferSecurePaymentMethodsRequiresSsnAskConsumerToIdentify

Possible next action to make

fieldReference

string <= 100 characters

Reference to field that caused an error

]
401 Authorization has been denied for this request.
500 Internal server error.

Path

post

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

Request samples

  • {
    • "captureNumber": "string",
    • "items": [ { ... }
      • {
        • "refundType": "string",
        • "productId": "string",
        • "groupId": "string",
        • "description": "string",
        • "type": "string",
        • "netUnitPrice": 1.00,
        • "grossUnitPrice": 1.00,
        • "quantity": 1.00,
        • "unitCode": "string",
        • "vatCategory": "string",
        • "vatPercent": 1.00,
        • "vatAmount": 1.00,
        • "imageUrl": "string",
        • "googleProductCategoryId": 1,
        • "googleProductCategory": "string",
        • "merchantProductType": "string",
        • "lineNumber": 1,
        • "productUrl": "string",
        • "marketPlaceSellerId": "string",
        • "parentTransactionReference": "string",
        • "additionalInformation": "string",
        • "specification": X,
        • "serviceStart": "string",
        • "serviceEnd": "string"
        }
      ],
    • "refundType": "string",
    • "parentTransactionReference": "string",
    • "transactionReference": "string",
    • "creditNoteNumber": "string",
    • "merchantId": "string"
    }

Response samples

200400
  • {
    • "totalCapturedAmount": 1.00,
    • "totalAuthorizedAmount": 1.00,
    • "refundNumbers": [
      • "string"
      ]      ,
    • "totalRefundedAmount": 1.00,
    • "remainingAuthorizedAmount": 1.00
    }
  • {
    • "type": "string",
    • "code": "string",
    • "message": "string",
    • "customerFacingMessage": "string",
    • "actionCode": "string",
    • "fieldReference": "string"
    }
Riverty Logo
Riverty Logo
About Us
Follow Riverty on LinkedIn
Riverty Status
Riverty Insights
Integrate Riverty
Documentation
Partner & Integrations
API Specification
Release Notes
Riverty Sandbox
Create Account
Login to Sandbox
Riverty 2023