post https://example.com/orders//transactions//refund/
The Refund Payment service is used to refund a Payment within Paynova's system.
HTTP Request
POST /orders/{orderId}/transactions/{transactionId}/refund/{totalAmount}
POST /transactions/{transactionId}/refund/{totalAmount}
When using the REST endpoints, the values supplied in the REST paths do not need to be supplied in the request body/object and will be used instead of values provided in the request body/object.
REQUEST PARAMETERS
| Property | Type | Description |
|---|---|---|
orderIdconditional | string | The unique identifier for the order which you received in the response from your original Create Order request. Conditions: > Required if refunding using order ID. Example: "1bee7570-76c0-495b-bc0a-a43300d0410c" |
transactionIdrequired | string | The transaction ID you received in your call to finalize authorization. Constraints: * The transaction must have been successfully finalized before a refund may be processed. Otherwise annul authorization should be used. |
totalAmountrequired | decimal | The total amount to refund. If provided, the amount must be equal to or less than the finalized amount. Example: 100.00 |
lineItemsconditional | lineitem | The line items which are being refunded. Conditions: > Line items are required if the totalAmount is less than the original finalized amount. > Line items may not be specified for simple orders. |