Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Payment Request

Info

As a merchant, you are expected to provide a payment request end point

Message Method

Description

HTTP POST

Once you have provided the payment request end point, monnify will call the end point when customer needs to make payment and expects a form of “value token“ in return e.g meter token for bills payment.

Request Parameters

Field

Description

amount

This is the amount the customer/payer wants to pay for product or service.

transactionReference

This is the unique reference for the transaction

productCode

This is the product code for the product to be purchased.

paymentRecipientId

This is the ID specified by customer as gotten from merchant for the product

Sample Request

Code Block
languagejson
{
   "amount":200,
   "transactionReference":"MNFY|66|20210825115615|000002",
   "productCode": "{productCode}",
   "paymentRecipientId":"{paymentRecipientId}}"
}

Response Parameters

Field

Description

responseCode

This is the response code for the transaction

00 - Successful

01 - Unsuccessful

productCode

This is the product code for the product to be purchased sent to merchant from the request.

paymentRecipientId

This is the payment recipient ID sent in the request

transactionReference

This is the unique reference for the transaction

paymentToken

This is the token to be returned by merchant that is required for the payment to be made.

Sample Response (Successful)

Code Block
languagejson
{
  "responseCode": "00",
  "productCode": "121221212",
  "paymentRecipientId":"{paymentRecipientId}}"
  "transactionReference":"MNFY|66|20210825115615|000002",
  "paymentToken": "{paymentToken}"
}

Response Parameters (Unsuccessful)

Field

Description

responseCode

This is the response code for the transaction

responseMessage

This describes the reason for the failed response

Sample Response (Unsuccessful)

Code Block
languagejson
{
  "responseCode": "01",
  "responseMessage": "Reason for failed response"
}

...