Create Payment

POST https://sandbox.momodeveloper.mtn.com/collection/v2_0/payment

Request

This API endpoint is used to initiate a payment collection by making an HTTP POST request to the specified URL. The request should include a payload in the raw request body

Request Body

  • externalTransactionId (text): The ID of the external transaction.

  • money.amount (text): The amount of the payment.

  • money.currency (text): The currency of the payment.

  • customerReference (text): Reference to the customer initiating the payment.

  • serviceProviderUserName (text): Username of the service provider.

  • couponId (text): ID of the coupon, if applicable.

  • productId (text): ID of the product.

  • productOfferingId (text): ID of the product offering.

  • receiverMessage (text): Message for the receiver of the payment.

  • senderNote (text): Note from the sender of the payment.

  • maxNumberOfRetries (text): Maximum number of retries for the payment.

  • includeSenderCharges (text): Indicator whether to include sender charges.

Response

The response of this request is a text/xml content with status 202.

Headers

The request may require specific headers for authentication or other purposes. Please refer to the API documentation for the required headers.

Other Details

Any other specific details related to the request and response will be available in the API documentation provided by the service provider.

Request Body

{"externalTransactionId"=>"457373", "money"=>{"amount"=>"2000", "currency"=>"EUR"}, "customerReference"=>"561551442", "serviceProviderUserName"=>"WaterProvider", "couponId"=>"203", "productId"=>"Monthly Payments", "productOfferingId"=>"788", "receiverMessage"=>"Thank You ", "senderNote"=>"Thank You", "maxNumberOfRetries"=>"2", "includeSenderCharges"=>"1"}

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