Refund

POST {{base_url}}/disbursement/v1_0/refund

Refund Disbursement

This endpoint allows the user to initiate a refund for a previous disbursement.

Request Body

  • amount (string): The amount to be refunded.
  • currency (string): The currency in which the refund amount is specified.
  • externalId (string): The external identifier for the refund transaction.
  • payerMessage (string): Message to be displayed to the payer (optional).
  • payeeNote (string): Note to be displayed to the payee (optional).
  • referenceIdToRefund (string): The reference ID of the disbursement to be refunded.

Response

The response will contain the status of the refund initiation and any relevant details.

Headers

Include the necessary headers for authorization and content type.

Other Details

Ensure that the required authorization and content type headers are included in the request.

Request Body

{"amount"=>"300", "currency"=>"EUR", "externalId"=>"Refund_uibi", "payerMessage"=>"Refund for MoMo Market Payment", "payeeNote"=>"Refund for MoMo Market Payment", "referenceIdToRefund"=>"{{Request_ID_Debit}}"}

HEADERS

KeyDatatypeRequiredDescription
X-Callback-Urlstringendpoint url to receive transaction status for (Failed or Successful) POST and PUT
X-Reference-IdstringUUID V4 string to identify the request (Unique for each request)
X-Target-EnvironmentstringEnvironment (sandbox or production syntax == mtn+country)
Content-TypestringSpecify the nature of the data in the body of a request
Ocp-Apim-Subscription-KeystringProduct primary subscription key, from momodeveloper.mtn.com