riverty logo

Docs

Return Notification

Allows merchants to notify Riverty that the customer has triggered a return notification. Please note: the return notification does not automatically trigger a refund to the consumer. This must be seperately triggered by the Merchant once they have receive the returned item and inspected it for damage.

Path

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

Request Parameters

orderNumber required
string
Order number

Request Body

application/json

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
Order items to return. Maximum allowed 200 items.
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

Successful RequestUnsuccessful Request, Incorrect Capture Number

Response Example

    
        {}
    

Request Example

    
        {
 "captureNumber": "800090330"
}