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 | ||||||||||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||||||||||
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:
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 |
RESPONSE SCHEMA:
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 |
Path
/api/v3/orders/{orderNumber}/refunds
Request samples
- {
- "captureNumber": "string",
- "items": [ { ... } ],
- "refundType": "string",
- "parentTransactionReference": "string",
- "transactionReference": "string",
- "creditNoteNumber": "string",
- "merchantId": "string"
Response samples
- {
- "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"