MakeRefund

Endpoint

Overview

The "MakeRefund" endpoint is a POST request. It is used to cancel the payment and return the funds to the customer. Detailed functionality of how to use this endpoint is explained in the Refund section.

The endpoint on Swagger is: Refund_MakeRefund.

Now, we are going to declare the endpoint and its models along with each accepted parameter and possible value.

📘

Request Header

Add "Authorization": "Bearer {Token}" to request header. Token of demo configuration can be found here.

❗️

Refund Request Responsibility

Please make sure to send one refund request each time, to avoid duplicate partial refund requests (You need to handle this from your system front-end side).
Moreover, Kindly note that the refund request responsibility is on the vendor side not on MyFatoorah Side.


Request Model

The request is a POST request with the following parameters:

Input Parameter

Type

Description

KeyType

string

State either it's "InvoiceId" or "PaymentId"

Key

string

Value of the key type mentioned

RefundChargeOnCustomer

boolean

Determine either the customer will be charged for the refund fees or not.
Refund fees (for the customer bank).

ServiceChargeOnCustomer

boolean

Determine either the customer will be charged for the service fees or not.
Service fees (for MyFatoorah).

Amount

decimal

The amount to be refunded

Comment

string

Extra comments for your reference

AmountDeductedFromSupplier

number, optional

This is the amount which will be deducted from the supplier in the refund process. It will be part form the total amount.

For example: If the total amount is 100 and the AmountDeductedFromSupplier is 70, the vendor will pay the 30 and the supplier will pay 70

❗️

Currency Parameter

In the request, the currency parameter has been omitted, as the value passed for the refund would represent the account default currency based on the token you are using. So, please get sure of the amount and used token as they determine the exact amount to be refunded.


Response Model

After viewing the Response Model that you will get as a result of your request, here, you will find full details about the Data Model of this API endpoint. Let's check it and its contents.

Response Field

Type

Description

Key

string

The key value you have passed for the Request Transaction

RefundId

number

RefundReference

string

The refund reference generated by MyFatoorah for following up with the finance team

Amount

string

The amount needed to be refunded

Comment

string

The comments that you have passed in the reques


Sample Message

{
  "KeyType": "invoiceid",
  "Key": "94272",
  "RefundChargeOnCustomer": false,
  "ServiceChargeOnCustomer": false,
  "Amount": 210,
  "Comment": "Test Api",
  "AmountDeductedFromSupplier": 0
}
{
  "IsSuccess": true,
  "Message": "Refund Created Successfully!",
  "ValidationErrors": null,
  "Data": {
    "Key": "94272",
    "RefundId": 2835,
    "RefundReference": "2020000036",
    "Amount": 210,
    "Comment": "test api"
  }
}


Did this page help you?