Home > API > Order Management > Return Notification

Return notification

PATH:

/api/v3/orders/{orderNumber}/captures/return-notification

PATH PARAMETERS:

orderNumber

required

string

Order number

REQUEST BODY SCHEMA:

captureNumber

required

string <= 50 characters

Capture number for return. This is the capture number which comes from Capture response

totalGrossAmount

number

Total gross amount of order. Must match the grossUnitPrice * quantity of order items

items

array of items

Order items to return. Maximum allowed 200 items.

Array () [

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:PhysicalArticleDigitalArticleGiftCardDiscountShippingFeeSurchargeInfo 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.
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.
productUrl	string <= 2048 characters URL to the product.
marketPlaceSellerId	string <= 32 characters ID of an individual seller on a marketplace.
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.

]

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.

RESPONSES:

200 OK

RESPONSE SCHEMA:

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}/captures/return-notification

Request samples

{"captureNumber": "string",
"totalGrossAmount": 1.00,
"items": [ { ... }{"productId": "string",
"groupId": "string",
"description": "string",
"type": "string",
"netUnitPrice": 1.00,
"grossUnitPrice": 1.00,
"quantity": 1.00,
"vatPercent": 1.00,
"vatAmount": 1.00,
"imageUrl": "string",
"productUrl": "string",
"marketPlaceSellerId": "string",
"additionalInformation": "string",
"specification": X,
"serviceStart": "string",
"serviceEnd": "string"
}
 ],
"parentTransactionReference": "string",
"transactionReference": "string"
}

Response samples

200400

{}

{"type": "string",
"code": "string",
"message": "string",
"customerFacingMessage": "string",
"actionCode": "string",
"fieldReference": "string"
}

Return notification

PATH:

PATH PARAMETERS:

REQUEST BODY SCHEMA:

RESPONSES:

RESPONSE SCHEMA:

RESPONSE SCHEMA:

Path

Request samples

Response samples

About Us

Integrate Riverty

Riverty Sandbox