...
Info |
---|
This endpoint is protected with OAuth 2.0 Bearer token. To find out more about authorization for Monnify endpoints, check Here |
Endpoint URL: {{base_url}}/api/v1/refunds/initiate-refund
...
Field | Description | Constraints |
transactionReference | Unique identifier for the transaction generated by Monnify. | Mandatory |
refundAmount | Amount to refund. Minimum value is N10, and maximum is total transaction amount. If not specified, total transaction amount will be refunded. | Optional - Defaults to transactionAmount. |
refundReason | A note describing reason why this transaction is being refunded. | Mandatory - limited to a 64 character sentence. |
customerNote | An optional note which will be serve as narration in credit to customer's bank account. | Optional - If provided, it should be limited to a 16 character sentence. |
refundStatus | Status of the refund. Possible values are IN_PROGRESS, FAILED, COMPLETED. | |
refundType | FULL_REFUND or PARTIAL_REFUND. FULL_REFUND is refund amount is total transaction amount. | |
createdOn | The data/time refund was initiated. | |
completedOn | Date and time refund was completed to customer. | |
comment | Comment describing status of the refund. If FAILED, comment will contain the reason for the failure. | |
refundReference | Unique identifier for the transaction refund generated by the merchant. This value would be used to retrieve the details of a transaction refund. | Mandatory - Unique reference generated by the merchant to identify the refund. |
destinationAccountNumber | Optional account number to send the refund amount to. Defaults to the customer account number on the transaction record. | Optional - If provided, you must also provide the destinationAccountBankCode. |
destinationAccountBankCode | Optional bank code for the destinationAccountNumber. This value would be used to identify the destination bank. Defaults to the customer bank code on the transaction record. | Optional - If provided, you must also provide the destinationAccountNumber. |
...
Response Codes
When a refund is initiated, the following response codes may be returned.
...