Refunds the payment
1min
POST
Authentication
Authorization
Bearer
Path Parameters
accountReference
string
*
paymentReference
string
*
Header Parameters
X-TokenId
string
X-SessionId
string
X-Version
string
*
Origin
string
Body Parameters
refundPaymentRequest
FictiveGlobal.Api.Rest.Dtos.v2.Payments.RefundPayment
*
Description
Refund Payment Request object class
amount
number<double>
triggerBackOfficeEmail
boolean
reason
string
reasonCode
string
refundAsServiceCredits
boolean
serviceCreditExpiry
string<date-time>
itemReference
string
Responses
204
No Content
400
Bad Request
401
Not Authorized
404
Order does not belong to client.
412
Precondition Failed
<br />β’ Service Credit expiry can only be specified when refunding the balance back as a credit.
<br />β’ Your client is not configured to use service credits.
<br />β’ An item reference is required when performing a partial refund on a bundle purchase
<br />β’ Unable to refund an amount greater than the initial item amount.
500
Internal Server Error
ο»Ώ
ο»Ώ
Updated 25 Mar 2024
Did this page help you?