Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Initiate Refund

...

Info
titleEndpoint
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.

...

FieldDescription

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.
createdOnThe data/time refund was initiated.
completedOnDate and time refund was completed to customer.
commentComment describing status of the refund. If FAILED, comment will contain the reason for the failure.


Response Codes

When refund is initiated, the following response codes may be returned.

...