Mindswave

Get Started
Get Started

Application API Documentation

Create a payment

Method: POST

URL: https://pay.mindswavepay.com/v1/billing/payment/init

Body of the Request:
				
					{
  "AppId": "{{privKey}}",
  "TransactionId": "{{transactionId}}",
  "TotalAmount": {{total}},
  "Hash": "{{digest}}",
  "Description": "Hello payment",
  "Webhook": "https://httpdump.akouendy.com/callback",
  "ReturnUrl": "https://www.akouendy.com",
  "Email": "toto@nama.com",
  "FullName": "Toto Nama",
  "SuccessMsg": "Merci pour votre paiement",
  "FailedMsg": "Paiement échoué"
}
Description of the query fields
  • AppId: Application ID (Private Key).
  • TransactionId: Unique identifier generated for the transaction in your SI.
  • TotalAmount: The total amount of the transaction.
  • Hash: A security hash generated by combining the private key, transaction ID, total amount, and a secret.
  • Description: Payment description.
  • Webhook: URL for callback notifications.
  • ReturnUrl: Return URL after payment
  • Email: The customer’s email address.
  • FullName: The full name of the client.
  • SuccessMsg: Success message to be displayed after checkout if ReturnUrl is not provided.
  • FailedMsg: Failure message to be displayed if payment fails if ReturnUrl is not provided.

Before creating a payment, it is necessary to generate a hash using the private key. The formula is hash is:

				
					SHA512(cléPrivé + "|" + transactionId + "|" + total + "|akouna_matata")

At the end of the payment, the customer is redirected to the url indicated in ReturnUrl enriched as follows: ReturnUrl?provider=[platform-payment]&status=[status]&token=[token]&transactionId=[transactionId].

 

  • [payment-platform] corresponds to the payment platform used: wave, orange-money-sn-api, ect
  • [status] is the status of the payment: failed or success
  • [token] corresponds to the payment ID in the Akouendy SI
  • [transactionId] is the identifier provided when the payment was created

When ReturnUrl is not populated, the client is redirected to the Akouendy status page.

Example of creating a 10 FCFA payment with Postman:

“Pre-request” script to calculate the hash

				
					POST: https://pay.mindswavepay.com/v1/billing/payment/init

This script executed before the request creates the hash and then adds it to a variable named “digest” in the collection.

The POST request in postman

				
					POST: https://pay.mindswavepy.com/v1/billing/payment/init
Response to Payment Creation:
				
					{
    "Code": "00",
    "Text": "Payment in progress",
    "Status": "INIT",
    "Token": "7e24db2d-f11d-4315-925d-b14185a30342",
    "PaymentUrl": "https://pay.akouendy.com/v1/product/buy/7e24db2d-f11d-4315-925d-b14185a30342?country=sen"
}
Description of response fields
  • Code: Its value is 00 when everything is going well.
  • Text: Payment Status Description
  • Status: Payment statatus
  • Token: Identifier of the payment in the Akouendy IS
  • PaymentUrl: Page displaying the payment details and payment methods

Webhook received after payment

When a payment is made, a POST request is sent with the url populated in the Webhook field of the request or in the Webhook field of the application used to initiate the request.

Webhook Request Body:
				
					{
  "TransactionID": "7e24db2d-f11d-4315-925d-b14185a30342",
  "Status": "SUCCESS",
  "Hash": "298348dee3b5a28a5042d00f599918ae7811edf8fb2ad29fa32bcb00a7c237",
}
Description of the query fields
  • TransactionID: Your identification of the payment used when creating the payment
  • Status: The status of the payment (INIT, PENDING, SUCCESS, FAILED)
  • Hash: A hash based on the token of the application used when creating the payment

The formula for the validation hash of the received webhook is:

				
					SHA512(Token + "|" + TransactionID + "|" + paymentStatus)

Search for a payment

Method: GET

				
					
URL: https://pay.mindswavepay.com/v1/payment/{paymenId}/{applicationId}
				
			
Description of the parameters in the url
  • paymenId: The identifier of the payment you are looking for
  • applicationId: The identifier of the application that was used to create the payment

Example of a search and response query:

Knowing:

  • AppId (Private Key): 2d2a358b-6f71-467b-a082-9f8777445be7
  • Payment ID (Token in Payment Creation Response): 7e24db2d-f11d-4315-925d-b14185a30342
				
					curl --location 'https://pay.mindswavepay.com/v1/payment/7e24db2d-f11d-4315-925d-b14185a30342/2d2a358b-6f71-467b-a082-9f8777445be7'

Answer: Data sent when the payment is created is returned in the MerchantData field.{

				
					{
    "Code": "00",
    "PaymentId": "7e24db2d-f11d-4315-925d-b14185a30342",
    "Status": "INIT",
    "MerchantData": {
        "Env": "",
        "Fees": 0,
        "Hash": "17cfeb4a58e715822a231ea64f9cd7a2aad2573761b57371ce0bd877c0cdeefb2706c998cccbd9b47bf6924165c2501b201717a0647b43ec11204278fcb66be5",
        "Rate": 0,
        "AppId": "b695ff5a-8a41-463b-ac3b-6c4ebbd01570",
        "Email": "toto@nama.com",
        "Webhook": "https://httpdump.akouendy.com/callback",
        "AppToken": "",
        "ClientId": "",
        "FullName": "Toto Nama",
        "FailedMsg": "Paiement échoué",
        "ReturnUrl": "https://www.akouendy.com",
        "SuccessMsg": "Merci pour votre paiement",
        "Description": "Hello payment",
        "TotalAmount": 10,
        "NotifChannel": "",
        "TransactionId": "d6384f1b-cdef-4b32-96ec-83fa59ca0e7f",
        "MerchantCreated": false,
        "TotalPayedAmount": 10
    }
}

Download the Postman Collection

Click here to download the postman collection.