Request To Pay

POST {{base_url}}/collection/v1_0/requesttopay

Create Request To Pay

This endpoint allows the client to initiate a request to pay.

Request Body

• amount (string): The amount to be requested.

• currency (string): The currency in which the amount is requested.

• externalId (string): The unique identifier for the request.

• payer (object):

  • partyIdType (string): The type of party ID for the payer.(MSISDN/ALIAS/EMAIL)
  • partyId (string): The ID of the payer.

• payerMessage (string): Message from the payer.

• payeeNote (string): Note for the payee.

Response (JSON Schema)

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Request Body Example

{
  "amount": "",
  "currency": "",
  "externalId": "",
  "payer": {
    "partyIdType": "",
    "partyId": ""
  },
  "payerMessage": "",
  "payeeNote": ""
}

Request Body

{"amount"=>"600", "currency"=>"EUR", "externalId"=>"00004335", "payer"=>{"partyIdType"=>"MSISDN", "partyId"=>"{{MSISDN}}"}, "payerMessage"=>"MoMo Market Payment", "payeeNote"=>"MoMo Market Payment"}

HEADERS