riverty logo

Docs

Refund Payment

Refunds a partially or fully captured payment.

More information can be found in our Documentation.

Path

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

Request Parameters

orderNumber required
string
Order number

Request Body

application/json

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
Order items to refund. Required for Partial Refund. Maximum allowed 200 items.
refundType
string Enum: [Refund, Return]
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 Account Manager, leave empty.

Responses

Successful Request, Full RefundSuccessful Request, Partial RefundSuccessful request, Refund with return costsUnsuccessful Request, Refund Amount Exceeds Capture Amount

Response Example

    
        {
 "totalCapturedAmount": 185,
 "totalAuthorizedAmount": 185,
 "refundNumbers": [
  "800090092"
 ],
 "totalRefundedAmount": 185,
 "remainingAuthorizedAmount": 0
}
    

Request Example

    
        null