MakeRefund

post

https://apitest.myfatoorah.com/v2/MakeRefund

Cancels a payment and returns the funds to the customer. This endpoint can be used for full or partial refunds. The refund can be processed using either InvoiceId or PaymentId.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

KeyType

string

enum

required

State either it's 'InvoiceId' or 'PaymentId' to identify the transaction to be refunded.

Allowed:

Key

string

required

Value of the key type mentioned. If KeyType is 'InvoiceId', provide the invoice ID. If KeyType is 'PaymentId', provide the payment ID.

ServiceChargeOnCustomer

boolean

Determine whether the customer will be charged for the service fees or not. Service fees are charged by MyFatoorah.

Amount

number

required

The amount to be refunded.

Comment

string

Extra comments for your reference.

ExternalIdentifier

string

External data associated with the refund, which will be received in the webhook.

AmountDeductedFromSupplier

number

This is the amount that will be deducted from the supplier in the refund process. It will be part of the total amount. For example: If the total amount is 100 and the AmountDeductedFromSupplier is 70, the vendor will pay 30 and the supplier will pay 70. This parameter is optional.

Response

200Refund processed successfully