Request To Withdraw
POST {{base_url}}/collection/v1_0/requesttowithdraw
Request
Description
This endpoint allows the user to initiate a request to withdraw funds.
Method
POST
URL
{{base_url}}/collection/v1_0/requesttowithdraw
Headers
- Content-Type: application/json
Body
- amount (string, required): The amount to be withdrawn.
- currency (string, required): The currency in which the withdrawal is to be made.
- externalId (string, required): The unique identifier for the withdrawal request.
- payer (object, required):
- partyIdType (string, required): The type of party ID for the payer.
- partyId (string, required): The ID of the payer.
- payerMessage (string, optional): A message from the payer.
- payeeNote (string, optional): A note for the payee.
Response
Status
202
Headers
- Content-Type: text/xml
Body
The response body is empty.
Request Body
{"amount"=>"3536636", "currency"=>"EUR", "externalId"=>"45757757", "payer"=>{"partyIdType"=>"MSISDN", "partyId"=>"{{MSISDN}}"}, "payerMessage"=>"MoMo Cash Out Thank You", "payeeNote"=>"MoMo Cash Out Thank You "}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Callback-Url | string | ||
X-Reference-Id | string | ||
X-Target-Environment | string | ||
Content-Type | string | ||
Ocp-Apim-Subscription-Key | string |