API Reference

MakeSupplierRefund

post
https://apitest.myfatoorah.com/v2/MakeSupplierRefund

Cancels a payment and returns the funds to the customer for invoices that have supplier information. This endpoint is specifically designed for the Multiple Suppliers feature and accepts invoices that contain one or more suppliers.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

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

Allowed:
string
required

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

number

The amount that the vendor will refund from their balance.

string

Extra comments for your reference.

string

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

Suppliers
array of objects

Array of RefundSupplier objects specifying the refund amounts for each supplier.

Suppliers
Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?