Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Initiate Refund

This API enables you process refund to a customer for a transaction.

Endpoint

GET: https://sandbox.monnify.com/api/v1/transactions/initiate-refund

Please note that this endpoint is protected using OAuth2 Token. Visit Authentication  section of this document for details on OAuth2 Token.

Request

Initiate Refund Request
{
    "transactionReference": "tranRef",
	"refundAmount": 1000.56,
	"refundReason": "Order cancelled!"
	"customerNote": "An optional note to be sent to customer",
}


Response

Initiate Refund Response
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
		"transactionReference": "MNFY|0111231|123412342",
		"transactionAmount": 5000,
		"refundAmount": 1200,
		"refundStatus": "IN_PROGRESS",
		"refundReason": "Order was cancelled",
		"customerNote": "Refund for order J1110",
		"createdOn": "15/12/2020 09:38:13 AM",
		"completedOn": "15/12/2020 12:20:23 PM",
		"comment": "Refund processed successfully."
    }
}

Field Reference

transactionReference

Unique identifier for the transaction generated by Monnify.

Yes

refundAmount

Amount to refund. Minimum value is N10, and maximum is total transaction amount. If not specified, total transaction amount will be refunded.

No. Defaults to transactionAmount.
refundReasonA note describing reason why this transaction is being refunded.Yes
customerNoteAn optional note which will be serve as narration in credit to customer's bank account.No
refundStatusStatus of the refund. Possible values are IN_PROGRESS, FAILED, COMPLETED.
  • No labels