v1

latestOpenAPI 3.0.02026-07-24440173.4 KB

Refund

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.

post/v2/MakeSupplierRefund

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.

VendorDeductAmountnumber

The amount that the vendor will refund from their balance.

Commentstring

Extra comments for your reference.

ExternalIdentifierstring

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

Response

Supplier refund processed successfully

IsSuccessboolean

Indicates if the request was successful.

Messagestring

Response message associated with the refund request.