MYmyfatoorah
Refund

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.

post/v2/MakeRefund

Request

  • Base URL
    https://apitest.myfatoorah.com
  • URL
    https://apitest.myfatoorah.com/v2/MakeRefund
  • Auth
    HTTP bearer

Request body

KeyType'InvoiceId' | 'PaymentId' required

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

Keystring required

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

ServiceChargeOnCustomerboolean

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

Amountnumber required

The amount to be refunded.

Commentstring

Extra comments for your reference.

ExternalIdentifierstring

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

AmountDeductedFromSuppliernumber

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

Refund processed successfully

IsSuccessboolean

Indicates if the request was successful.

Messagestring

Response message associated with the request.

Changes

No recorded changes to this operation across all 1 revision of this API.