MaishaPay REST API Overview
\nMaishaPay REST API is a powerful and flexible solution that allows businesses, merchants, and developers to integrate advanced payment and financial transaction management features into their existing applications or systems.
\nMaishaPay REST API provides a suite of tools for:
\nOnline Collection: Enabling merchants to collect online payments via various solutions, including:
\nMobile Money: Integration with mobile wallets like Airtel Money, M-Pesa, and Orange Money.
\nBank Cards: Support for payments via Visa, Mastercard, and other cards.
\nCryptocurrencies: Integration for receiving payments in crypto.
\nFund Transfers:
\nDirect transfer to Mobile Money accounts.
\nTransfer to bank cards.
\nMobile Recharge and Data Sales:
\nTV Subscription Payments:
\nInternational Operations: The platform operates in several African countries, including:
\nDemocratic Republic of Congo (DRC)
\nRepublic of Congo
\nCameroon
\nSenegal
\nBenin
\nIvory Coast
\nTogo
\nAnd soon in Ghana, Nigeria, Egypt, etc...
\nPartnership with CyberSource (Visa):
For card payments, MaishaPay relies on CyberSource, a secure and robust payment platform provided by Visa.
The API is accessible via the following base URL:
\nhttps://marchand.maishapay.online/api\n\nGET: Retrieve data.
\nPOST: Send or create new data.
\nPUT: Update existing data.
\nDELETE: Remove resources.
\nThe API responses are uniform and in JSON format.
\nCollect payments for products or services.
\nTransfer funds to bank or mobile accounts.
\nOffer phone recharges and TV subscriptions to your customers.
\nAutomate tracking of payments and transactions.
\nIn version 1.0 of Mobile Money collection, only the M-Pesa operator in the Democratic Republic of Congo (DRC) is supported. When the request is sent, a push notification is sent to the final customer's phone, allowing them to validate the transaction by entering their PIN code, known only to them. This method ensures secure authentication and reliable execution of transactions.
\nIn this version, there is no callback to notify the merchant once the transaction is completed. The connection between the merchant's server and MaishaPay's server remains active until the final transaction status is received from the operator.
\nURL: https://marchand.maishapay.online/api/payment/rest/vers1.0/merchant
HTTP Method: POST
\nSuccess Response
\n{\n \"status\": 200,\n \"data\": {\n \"transactionReference\": \"gdt458\",\n \"statusCode\": \"200\",\n \"status\": \"APPROVED\",\n \"transactionDate\": \"01/01/2023 01:01:01\",\n \"transactionDescription\": \"General Payments\",\n \"transactionId\": \"123564\"\n }\n}\n\nError Response
\n{\n \"status\": 400,\n \"data\": {\n \"transactionReference\": \"gdt458\",\n \"statusCode\": \"400\",\n \"status\": \"DECLINED\",\n \"transactionDate\": \"01/01/2023 01:01:01\",\n \"transactionDescription\": \"Invalid walletID\",\n \"transactionId\": \"123456\"\n }\n}\n\nDescription:
\nIt may rarely happen that a transaction remains in a PENDING (201) status due to a delay or technical issue with the operator (M-Pesa).
\nImpact:
\nThe final customer may be charged, but the transaction will not be immediately confirmed by the operator.
\nIn this case, the merchant or the final customer is asked to provide proof of debit (e.g., a screenshot or statement) to allow further verification with the operator.
\nExample of Response for Pending Transaction
\n{\n \"status\": 201,\n \"data\": {\n \"transactionReference\": \"gdt458\",\n \"statusCode\": \"202\",\n \"status\": \"PENDING\",\n \"transactionDate\": \"01/01/2023 01:01:01\",\n \"transactionDescription\": \"Transaction awaiting confirmation from the operator.\",\n \"transactionId\": \"123456\"\n }\n}\n\nA notification is sent to the merchant indicating that the transaction is pending.
\nThe merchant or final customer must provide proof of debit (e.g., a screenshot).
\nMaishaPay uses this proof to perform a verification with the operator.
\nOnce the verification is complete, MaishaPay sends an update to the merchant with the final status of the transaction (APPROVED or DECLINED).
\nUpon sending the request, a push notification is sent to the final customer's phone.
\nThe customer must validate the transaction by entering their PIN code on their phone, ensuring that only the account holder can authorize the transaction.
\nOnce the validation is complete, the final status of the transaction is transmitted to MaishaPay and sent back to the merchant via the same connection.
\nIn this version, there is no callback sent to the merchant. The connection between the merchant's server and MaishaPay's server remains active until the final transaction status is received from the M-Pesa operator. This method ensures an instant and secure response for each transaction.
\n","urlObject":{"path":["payment","rest","vers1.0","merchant"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[{"id":"aff40986-8248-4b09-968a-3921d22b5c2b","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionReference\": \"k78Pu472\",\r\n \"gatewayMode\" : \"1\", // Gateway mode 1: Production; 0: Sandbox\r\n \"publicApiKey\" : \"MP-LIVEPK-kK6yCY09V1jxxxxxxxxxx\" , // your public API key, required|string',\r\n \"secretApiKey\" : \"MP-LIVEPK-TpJWW05QUG$xxxxxxxxxx\" , // your secret API key, required|string',\r\n \"amount\": 100,\r\n \"currency\" : \"CDF\", // Currency required CDF or USD \r\n \"chanel\":\"MOBILEMONEY\",\r\n \"provider\":\"MPESA\",\r\n \"walletID\":\"+243823616356\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/payment/rest/vers1.0/merchant"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2025 18:07:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"5971f48d98e7eaec95f4632af2f479b7"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"5971f48d98e7eaec95f4632af2f479b7"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=d9kGFsiD7PtLqGhoLgajF0vJkAA60iPJIZqB0dfCsXKPatJLZUGctnXfdQkyCMbFeZuW89f0BRsM%2BxQVXQGw5nOLpnADS7STThF9tz%2FfsgnsHCT%2B2M2nsY%2FHqDhXVBGsZLyJp4J9jAXLfPys\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9017534d6ffb03d2-LIS"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=102615&min_rtt=102359&rtt_var=38897&sent=4&recv=4&lost=0&retrans=0&sent_bytes=2823&recv_bytes=1418&delivery_rate=27584&cwnd=230&unsent_bytes=0&cid=a61e062839a62d65&ts=35168&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"transactionReference\": \"k78Pu472\",\n \"transactionId\": \"849311\",\n \"statusCode\": \"200\",\n \"status\": \"APPROVED\",\n \"transactionDescription\": \"General Payments\",\n \"transactionDate\": \"01/13/2025 18:07:23\"\n }\n}"},{"id":"55a3542d-abeb-41e3-94a4-58296846542a","name":"Failed Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionReference\": \"78POi\",\r\n \"gatewayMode\" : \"1\", // Gateway mode 1: Production; 0: Sandbox\r\n \"publicApiKey\" : \"MP-LIVEPK-XXX\" , // your public API key, required|string',\r\n \"secretApiKey\" : \"MP-LIVEPK-XXX\" , // your secret API key, required|string',\r\n \"amount\": 100,\r\n \"currency\" : \"CDF\", // Currency required CDF or USD \r\n \"chanel\":\"MOBILEMONEY\",\r\n \"provider\":\"MPESA\",\r\n \"walletID\":\"+24381XXXXXXX\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/payment/rest/vers1.0/merchant"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 13 Jan 2025 18:20:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"2392a2396794d7e2f99cffec349fedd0"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=SmRMTb8CRpNRYV%2BjXQVVvop8FruvPJNfUBMe8uVKHLtxfKO75CHAynhbFOM1DHdMqZeLnBZSeVzY3LzkJPUkJFAbPOxTiPc%2BZVKCZUg8lQMvIDDSDQYuJ2W7RZg2%2BhvpmTwGeMkl8EfIycn%2B\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"901765c2ce39489f-LIS"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=100990&min_rtt=100480&rtt_var=38701&sent=4&recv=4&lost=0&retrans=0&sent_bytes=2825&recv_bytes=1421&delivery_rate=27542&cwnd=244&unsent_bytes=0&cid=79cdbbf15947b50c&ts=41284&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"transactionReference\": \"kIPOu472\",\n \"transactionId\": \"849342\",\n \"statusCode\": \"400\",\n \"status\": \"DECLINED\",\n \"transactionDescription\": \"General Payments\",\n \"transactionDate\": \"01/13/2025 18:19:58\"\n }\n}"}],"_postman_id":"76a0f88c-23a3-4472-b2de-278db08e0575"},{"name":"Collection version 2.0","id":"94b9160a-7afd-43a0-9a61-896d54e6e8ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://marchand.maishapay.online/api/collect/v2/store/mobileMoney","description":"Version 2.0 of the Mobile Money Collection now supports all remaining operators in each country. For example:
DRC: Orange Money, Airtel Money
Other countries: See the full list of operators defined in the main documentation.
This version allows merchants to integrate payments via Mobile Money for all supported operators, with simplified transaction management and notifications through a callback URL.
\nURL: https://marchand.maishapay.online/api/collect/v2/store/mobileMoney
HTTP Method: POST
{\n \"transactionReference\" : \"XXXX\", // required|unique\n \"gatewayMode\" : \"1\", // Gateway mode 1: Production; 0: Sandbox\n \"publicApiKey\" : \"MP-LIVEPK-kK6yCY09V1jxxxxxxxxxx\", // your public API key, required|string\n \"secretApiKey\" : \"MP-LIVEPK-TpJWW05QUG$xxxxxxxxxx\", // your secret API key, required|string\n \"order\" : {\n \"amount\" : \"1000000\", \n \"currency\" : \"CDF\", // currency CDF, USD, XAF, XOF, ....\n \"customerFullName\" : \"Hermacle Johnnson\", \n \"customerEmailAdress\" : \"hermacle@email.com\"\n },\n \"paymentChannel\" : {\n \"channel\" : \"MOBILEMONEY\", \n \"provider\" : \"AIRTEL\", // required : AIRTEL, ORANGE, MTN, ....\n \"walletID\" : \"+24399XXXXXXX\",\n \"callbackUrl\" : \"https://your_domaine.com/mobile_calback\"\n } \n}\n\nWhen the request is sent, if all parameters are correct, the merchant receives the following initial response:
\n{\n \"status_code\": 202,\n \"transactionStatus\": \"PENDING\",\n \"transactionId\": 12345,\n \"originatingTransactionId\": \"XXXX\",\n \"order\": {\n \"customerFullName\": \"Hermacle Johnnson\",\n \"customerEmailAdress\": \"hermacle@email.com\",\n \"cost\": {\n \"amount\": 100,\n \"frais\": 4,\n \"total\": 104,\n \"currency\": \"CDF\"\n }\n },\n \"paymentChannel\": {\n \"channel\": \"MOBILEMONEY\",\n \"provider\": {\n \"libelle\": \"AIRTEL\",\n \"picture\": \"service-logos/airtelmoney.png\"\n },\n \"walletID\": \"+243997447204\"\n },\n \"created_at\": \"14-01-2025 12:27\",\n \"updated_at\": \"14-01-2025 12:27\"\n}\n\nThis result means that the transaction has been successfully initiated on MaishaPay's servers and sent to the operator.
The operator then sends a push notification to the end customer to validate the transaction using their PIN code on their phone.
Once validated, the operator sends the final transaction status back to MaishaPay, which forwards it to the merchant via the callbackUrl.
Once the operator processes the transaction (after validation by the end customer via their PIN), MaishaPay receives the final status from the operator.
This final status is then forwarded to the merchant via a notification sent to the URL specified in the callbackUrl field of the initial request.
This notification is performed with a POST request.
{\n \"status_code\": 200,\n \"transactionStatus\": \"SUCCESS\",\n \"transactionId\": 12345,\n \"originatingTransactionId\": \"XXXX\",\n \"order\": {\n \"customerFullName\": \"Hermacle Johnnson\",\n \"customerEmailAdress\": \"hermacle@email.com\",\n \"cost\": {\n \"amount\": 100,\n \"frais\": 4,\n \"total\": 104,\n \"currency\": \"CDF\"\n }\n },\n \"paymentChannel\": {\n \"channel\": \"MOBILEMONEY\",\n \"provider\": {\n \"libelle\": \"AIRTEL\",\n \"picture\": \"service-logos/airtelmoney.png\"\n },\n \"walletID\": \"+24399XXXXXXX\"\n },\n \"created_at\": \"14-01-2025 12:27\",\n \"updated_at\": \"14-01-2025 12:57\"\n}\n\nstatus_code: 200: Indicates that the transaction was successfully processed by the operator.
\ntransactionStatus: SUCCESS: Confirms that the amount was debited from the customer's account and credited to the merchant.
\nDetails Included:
\nTransaction: transactionId and originatingTransactionId allow matching transactions between the merchant's and MaishaPay's systems.
Customer: Information about the end customer, such as their full name (customerFullName) and email (customerEmailAdress).
Payment: The debited amount, applied fees, and total paid (amount, frais, total).
Mobile Money Provider: Indicates the operator used (provider.libelle) with an optional logo (provider.picture).
Timestamps: created_at and updated_at indicate when the transaction was initiated and finalized.
{\n \"status_code\": 400,\n \"transactionStatus\": \"FAILED\",\n \"transactionId\": 12345,\n \"originatingTransactionId\": \"XXXX\",\n \"order\": {\n \"customerFullName\": \"Hermacle Johnnson\",\n \"customerEmailAdress\": \"hermacle@email.com\",\n \"cost\": {\n \"amount\": 100,\n \"frais\": 4,\n \"total\": 104,\n \"currency\": \"CDF\"\n }\n },\n \"paymentChannel\": {\n \"channel\": \"MOBILEMONEY\",\n \"provider\": {\n \"libelle\": \"AIRTEL\",\n \"picture\": \"service-logos/airtelmoney.png\"\n },\n \"walletID\": \"+24399XXXXXXX\"\n },\n \"created_at\": \"14-01-2025 12:27\",\n \"updated_at\": \"14-01-2025 12:57\"\n}\n\nstatus_code: 400: Indicates that an error occurred at the operator level or that the end customer did not validate the transaction.
\ntransactionStatus: FAILED: Confirms that the transaction was not completed. Funds were not debited from the customer.
\nDetails Included: The information provided in the response helps diagnose the error, though additional details may be obtained via logs or support services.
\nPossible Failure Scenarios:
\nThe end customer did not validate the transaction (no PIN entry).
\nThe customer's Mobile Money account had insufficient funds.
\nThe operator encountered a temporary technical issue.
\nRarely, a transaction may remain in a PENDING status (202) due to operator delays. In this case:
\nIf the end customer was debited, they must provide proof (e.g., a screenshot) to verify with the operator.
\nOnce validated, the final status will be updated and sent to the merchant via the callbackUrl.
Version 2.0 enhances operator coverage and notification flexibility. Real-time transaction management via a callbackUrl ensures efficient communication between merchants, MaishaPay, and operators.
Mobile Money collection is a key feature of MaishaPay that allows merchants to receive payments directly through Mobile Money operators available in several African countries. This system facilitates financial transactions in environments where electronic wallets are widely used, providing an accessible and convenient solution for end users.
\nSupported Countries and Operators
\nHere is the table of countries and operators supported for Mobile Money collection:
\nObjective
\nMobile Money collection enables seamless integration with local operators, ensuring that merchants can receive payments within their operational regions. This solution is ideal for countries where electronic wallets play a crucial role in the digital economy.
\n","_postman_id":"06b705e1-49a8-4439-90df-2e0e7c6b1e56"},{"name":"Collection via Card","item":[{"name":"Card collection v2","id":"7e262507-b79f-4959-9d14-f43f40d6ada3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://marchand.maishapay.online/api/collect/v2/store/card","description":"URL: https://marchand.maishapay.online/api/collect/v2/store/card
HTTP Method: POST
{\n \"transactionReference\": \"XXXX\", \n \"gatewayMode\": \"1\",\n \"publicApiKey\": \"MP-LIVEPK-kK6yCY09V1jxxxxxxxxxx\",\n \"secretApiKey\": \"MP-LIVEPK-TpJWW05QUG$xxxxxxxxxx\",\n \"order\": {\n \"amount\": \"1\",\n \"currency\": \"USD\",\n \"customerFullName\": \"Joe Smith\",\n \"customerPhoneNumber\": \"+12025550198\",\n \"customerEmailAdress\": \"joesmith@example.com\"\n },\n \"paymentChannel\": {\n \"channel\": \"CARD\",\n \"provider\": \"VISA\",\n \"callbackUrl\": \"https://your_domaine.com/calback_url\"\n }\n}\n\n{\n \"status_code\": 202,\n \"transactionId\": 1234,\n \"originatingTransactionId\": \"XXXX\",\n \"transactionStatus\": \"Pending\",\n \"transactionDescription\": \"Accepted\",\n \"paymentPage\": \"https://marchand.maishapay.online/api/collect/postRedirectionRequest/1234\",\n \"updated_at\": \"14-01-2025 14:14\"\n}\n\nInitial Response (202):
If the request is valid, MaishaPay initializes the transaction and returns a response containing:
paymentPage: URL allowing the merchant to redirect the customer to CyberSource to finalize the transaction.
transactionId and originatingTransactionId: Identifiers for tracking the transaction.
Redirection to CyberSource:
The merchant uses the paymentPage URL to redirect the customer to the CyberSource platform, where they can enter their card details and complete the transaction.
Once the transaction is finalized on CyberSource, a notification is sent to the merchant via the URL defined in callbackUrl.
This notification is a GET request, including the final status of the transaction.
Plain Text:
\nhttps://your_domaine.com/calback_url/?status=200&description=APPROVED&transactionRefId=XXXX&operatorRefId=1234\n\nExplanation:
\nstatus=200: The transaction was successfully validated.
description=APPROVED: Confirmation that the payment was accepted.
transactionRefId: Your ID sent in transactionReference.
operatorRefId: The transaction ID at MaishaPay.
Plain Text:
\nhttps://your_domaine.com/calback_url/?status=400&description=DECLINED&transactionRefId=XXXX&operatorRefId=1234\n\nExplanation:
\nstatus=400: The transaction was declined (e.g., invalid card, insufficient funds, etc.).
description=DECLINED: Details of the reason for the refusal.
Plain Text:
\nhttps://your_domaine.com/calback_url/?status=400&description=CANCELED&transactionRefId=XXXX&operatorRefId=1234\n\nExplanation:
\nstatus=400: The transaction was canceled by the customer.
description=CANCELED: The customer left the process without finalizing the transaction.
Notification GET and Verification:
\nGET notifications can be altered during transit.
\nIt is strongly recommended that the merchant initiates a status lookup request (see the Transaction Lookup section) to confirm the final status and ensure its reliability.
\nSecurity:
\ncallbackUrl is secured and validate the received data to prevent any fraudulent manipulation or alteration of notifications.The V3 version of card payment collection allows the merchant to include the customer's billing information (first name, address, city, etc.) directly in the request. This simplifies the payment process for the customer, who is redirected directly to the step where they only need to enter their card details, reducing friction and improving the user experience.
\nURL: https://marchand.maishapay.online/api/collect/v3/store/card
HTTP Method: POST
{\n \"transactionReference\": \"XXXX\", // required\n \"gatewayMode\": \"0\",\n \"publicApiKey\": \"MP-SBPK-XXXXX\", // your public API key, required|string\n \"secretApiKey\": \"MP-SBPK-XXXXX\", // your secret API key, required|string\n \"order\": {\n \"amount\": \"1\", // required|numeric\n \"currency\": \"USD\", // required, [USD|EURO]\n \"customerFirstname\": \"Joe\", // required\n \"customerLastname\": \"Doe\", // required\n \"customerAddress\": \"1 Crystal Palace\", // required\n \"customerCity\": \"Kinshasa\", // required\n \"customerPhoneNumber\": \"+24381XXXXXXX\", // required\n \"customerEmailAdress\": \"myemail@email.com\" // required\n },\n \"paymentChannel\": {\n \"channel\": \"CARD\", // required, CARD\n \"provider\": \"MASTERCARD\", // required, [VISA|MASTERCARD|AMERICAN EXPRESS]\n \"callbackUrl\": \"https://your_domaine.com/mobile_calback\" // required|Url, HTTPS\n }\n}\n\norder: Contains the customer’s billing details, reducing the number of steps required to finalize the payment.
\npaymentChannel: Allows specifying the card provider (e.g., VISA, MASTERCARD) and the callback URL to receive the final transaction status.
\n{\n \"status_code\": 202,\n \"transactionId\": 1234,\n \"originatingTransactionId\": \"XXXX\",\n \"transactionStatus\": \"Pending\",\n \"transactionDescription\": \"Accepted\",\n \"paymentPage\": \"https://marchand.maishapay.online/api/collect/postRedirectionRequest/1234\",\n \"updated_at\": \"14-01-2025 14:14\"\n}\n\nInitial Response (202):
If the request is valid, MaishaPay initializes the transaction and returns a response containing:
paymentPage: URL allowing the merchant to redirect the customer to CyberSource to finalize the transaction.
transactionId and originatingTransactionId: Identifiers for tracking the transaction.
Redirection to CyberSource:
The merchant uses the paymentPage URL to redirect the customer to the CyberSource platform, where they can enter their card details and complete the transaction.
Once the transaction is finalized on CyberSource, a notification is sent to the merchant via the URL defined in callbackUrl.
This notification is a GET request, including the final status of the transaction.
Plain Text:
\nhttps://your_domaine.com/calback_url/?status=200&description=APPROVED&transactionRefId=XXXX&operatorRefId=1234\n\nExplanation:
\nstatus=200: The transaction was successfully validated.
description=APPROVED: Confirmation that the payment was accepted.
transactionRefId: Your ID sent in transactionReference.
operatorRefId: The transaction ID at MaishaPay.
Plain Text:
\nhttps://your_domaine.com/calback_url/?status=400&description=DECLINED&transactionRefId=XXXX&operatorRefId=1234\n\nExplanation:
\nstatus=400: The transaction was declined (e.g., invalid card, insufficient funds, etc.).
description=DECLINED: Details of the reason for the refusal.
Plain Text:
\nhttps://your_domaine.com/calback_url/?status=400&description=CANCELED&transactionRefId=XXXX&operatorRefId=1234\n\nExplanation:
\nstatus=400: The transaction was canceled by the customer.
description=CANCELED: The customer left the process without finalizing the transaction.
Notification GET and Verification:
\nGET notifications can be altered during transit.
\nIt is strongly recommended that the merchant initiates a status lookup request (see the Transaction Lookup section) to confirm the final status and ensure its reliability.
\nSecurity:
\ncallbackUrl and validate the received data to prevent any fraudulent manipulation or alteration of notifications.MaishaPay relies on Visa's CyberSource platform to provide a reliable and secure card payment collection solution. CyberSource is an online payment processing platform developed by Visa, which supports various types of cards, including:
\nVISA
\nMASTERCARD
\nAMERICAN EXPRESS
\nThe card payment collection process comes in two versions, each with its own specific features:
\nThe customer is redirected to a billing form hosted by CyberSource, where they must enter their personal information and billing details.
\nThis form is divided into multiple steps, guiding the customer through to the completion of the payment.
\nThe merchant includes the customer’s billing information (name, address, etc.) directly in the request.
\nOnce the request is sent and validated, the customer is redirected directly to a page where they only need to enter their card details, reducing the number of steps.
\nThis modular system offers merchants the flexibility to choose the version that best suits their needs in terms of user experience and integration.
\n","_postman_id":"66ca7e1c-6a39-4a11-9322-171338903df9"},{"name":"Collection via Crypto Money","item":[],"id":"5682fbbb-9cf9-40c6-b137-a1cc689265db","_postman_id":"5682fbbb-9cf9-40c6-b137-a1cc689265db","description":""}],"id":"6f99f333-1d9c-4f38-b3df-cd6f95f4e48e","description":"The MaishaPay Collection module allows merchants to receive payments directly through three main channels: Mobile Money, Bank Cards, and Cryptocurrencies. This module provides a fast, secure, and integrated solution to simplify online merchants' financial transactions.
The collected funds can be transferred to Mobile Money wallets or bank accounts, offering great flexibility to users.
The Mobile Money Transfer module allows merchants and businesses to transfer funds directly to the Mobile Money wallets of beneficiaries. This solution is ideal for payments such as refunds, salaries, or other types of direct payments.
\nMaishaPay supports various operators in the countries where it operates, including the DRC, Congo-Brazzaville, Cameroon, Senegal, Côte d’Ivoire, Benin, Togo, Mali, and Burkina Faso.
\nURL: https://marchand.maishapay.online/api/b2c/store/transfert/mobilemoney
HTTP Method: POST
{\n \"transactionReference\": \"XXXX\",\n \"gatewayMode\": \"1\",\n \"publicApiKey\": \"MP-LIVEPK-XXXXX\",\n \"secretApiKey\": \"MP-LIVEPK-XXXXX\",\n \"order\": {\n \"motif\": \"Transfert vers Momo\",\n \"amount\": \"20000\",\n \"currency\": \"CDF\",\n \"customerFullName\": \"Landry Ngoya\",\n \"customerEmailAdress\": \"\"\n },\n \"paymentChannel\": {\n \"provider\": \"AIRTEL\",\n \"walletID\": \"+24399XXXXXXX\",\n \"callbackUrl\": \"https://your_domaine.com/your_calback\"\n }\n}\n\n{\n \"status_code\": 200,\n \"transactionStatus\": \"SUCCESS\",\n \"transactionId\": 1234,\n \"originatingTransactionId\": \"XXXX\",\n \"recipient\": {\n \"customerFullName\": \"Landry Ngoya\",\n \"customerEmailAdress\": \"N/A\",\n \"walletID\": \"+24381XXXXXXX\"\n },\n \"provider\": {\n \"libelle\": \"MPESA\",\n \"picture\": \"service-logos/mpesa.png\"\n },\n \"cost\": {\n \"amount\": 200,\n \"frais\": 0,\n \"total\": 200,\n \"currency\": \"CDF\"\n },\n \"motif\": \"Transfert vers Momo\",\n \"date\": \"17-01-2025 15:29\"\n}\n\n{\n \"status_code\": 400,\n \"transactionStatus\": \"FAILED\",\n \"transactionId\": 12345,\n \"originatingTransactionId\": \"XXXXX\",\n \"recipient\": {\n \"customerFullName\": \"Landry Ngoya\",\n \"customerEmailAdress\": \"N/A\",\n \"walletID\": \"+24399XXXXXXX\"\n },\n \"provider\": {\n \"libelle\": \"AIRTEL\",\n \"picture\": \"service-logos/airtelmoney.png\"\n },\n \"cost\": {\n \"amount\": 20000,\n \"frais\": 0,\n \"total\": 20000,\n \"currency\": \"CDF\"\n },\n \"motif\": \"Transfert vers Momo\",\n \"date\": \"17-01-2025 15:57\"\n}\n\nInitial Response:
Once the request is successfully sent, the merchant receives a response indicating the final status (SUCCESS or FAILED).
The response includes key details such as the transferred amount, the beneficiary, and the provider.
Automatic Notification:
An HTTP POST notification is also sent to the merchant via the URL specified in callbackUrl. This notification contains the same details as the response.
Success Case:
\nThe amount is successfully transferred to the beneficiary's Mobile Money wallet.
\nThe beneficiary receives an SMS notification from their operator confirming receipt of the funds.
\nThe status is SUCCESS, and tracking information is provided.
Failure Case:
\nThe transaction fails due to reasons such as an incorrect number, insufficient funds, or a technical issue with the operator.
\nThe status is FAILED, with details provided for diagnostics.
The Mobile Money Transfer module of MaishaPay ensures a reliable and secure experience for money transfers while providing real-time notifications to ensure full transparency in the process.
\n","urlObject":{"path":["b2c","store","transfert","mobilemoney"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[{"id":"0628032e-fb43-4205-b9db-645982fdabfd","name":"Réponse de Succès","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionReference\" : \"XXXX\", // required|string|unique\r\n \"gatewayMode\" : \"1\", //required, 0 : sandbox 1:production\r\n \"publicApiKey\" : \"MP-LIVEPK-XXXXX\", // your public API key, required|string',\r\n \"secretApiKey\" : \"MP-LIVEPK-XXXXX\", // your secret API key, required|string',\r\n \"order\" : {\r\n \"motif\" : \"Transfert vers Momo\" , //nullable',\r\n \"amount\" : \"200\" , //required|numeric',\r\n \"currency\" : \"CDF\" , //required',\r\n \"customerFullName\" : \"Landry Ngoya\" , //'nullable|string',\r\n \"customerEmailAdress\" : \"\" //nullable|email',\r\n },\r\n \"paymentChannel\" : {\r\n \"provider\" : \"MPESA\", //required'\r\n \"walletID\" : \"+24381XXXXXXX\", // recipient phone , required|phone',+243xxxxxxx\r\n \"callbackUrl\" : \"https://your_domaine.com/your_calback\" // required|url\r\n } \r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/b2c/store/transfert/mobilemoney"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2025 15:29:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"0ed913623c97a5f421868a95ea28fc03"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"0ed913623c97a5f421868a95ea28fc03"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=L1Y%2FLTkM2D6HtQGDN%2Fx1Kd2mH%2FwhiAc1Chv35vcUQ%2BGmW8GO%2Ba9LzbBgIQGWx6OMmMP0THNpY3Ahybry9Qj8WPGS2kXfpuj07f15%2FMqC5MJT3fwvgTWSaARU4GzJ7TiJ2ZGMWOMzTxXGDKMa\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9037617da989229e-CDG"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=129620&min_rtt=128759&rtt_var=50008&sent=4&recv=4&lost=0&retrans=0&sent_bytes=2824&recv_bytes=1662&delivery_rate=21230&cwnd=242&unsent_bytes=0&cid=27f7c30cf43b8f08&ts=4161&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"transactionStatus\": \"SUCCESS\",\n \"transactionId\": 1234,\n \"originatingTransactionId\": \"XXXX\",\n \"recipient\": {\n \"customerFullName\": \"Landry Ngoya\",\n \"customerEmailAdress\": \"N/A\",\n \"walletID\": \"+24381XXXXXXX\"\n },\n \"provider\": {\n \"libelle\": \"MPESA\",\n \"picture\": \"service-logos/mpesa.png\"\n },\n \"cost\": {\n \"amount\": 200,\n \"frais\": 0,\n \"total\": 200,\n \"currency\": \"CDF\"\n },\n \"motif\": \"Transfert vers Momo\",\n \"date\": \"17-01-2025 15:29\"\n}"},{"id":"9c926367-0413-4307-9cfb-9faf9d8f95fa","name":"Réponse d'Echec","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionReference\" : \"XXXX\", // required|string|unique\r\n \"gatewayMode\" : \"1\", //required, 0 : sandbox 1:production\r\n \"publicApiKey\" : \"MP-LIVEPK-XXXXX\", // your public API key, required|string',\r\n \"secretApiKey\" : \"MP-LIVEPK-XXXXX\", // your secret API key, required|string',\r\n \"order\" : {\r\n \"motif\" : \"Transfert vers Momo\" , //nullable',\r\n \"amount\" : \"20000\" , //required|numeric',\r\n \"currency\" : \"CDF\" , //required',\r\n \"customerFullName\" : \"Landry Ngoya\" , //'nullable|string',\r\n \"customerEmailAdress\" : \"\" //nullable|email',\r\n },\r\n \"paymentChannel\" : {\r\n \"provider\" : \"AIRTEL\", //required'\r\n \"walletID\" : \"+24399XXXXXXX\", // recipient phone , required|phone',+243xxxxxxx\r\n \"callbackUrl\" : \"https://your_domaine.com/your_calback\" // required|url\r\n } \r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/b2c/store/transfert/mobilemoney"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2025 15:57:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"7ce86eb96bbeff9f7ef39a004204f5ff"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=UP%2FEsTxOvwY4qvdRMySMp8w0rbAr5oY98fT4Q45eHS9dxyNfL7004sbf07CEAsOjHAIM2NfK8LoA2fKHtyt69U8%2FdF8qOTITMQODKDYuux1rjAKFaPmqhYosSxxQSXE20UVDnihNxhNH60vK\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90378a2c2e51f097-CDG"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=133510&min_rtt=131617&rtt_var=50709&sent=4&recv=5&lost=0&retrans=0&sent_bytes=2825&recv_bytes=1664&delivery_rate=21881&cwnd=251&unsent_bytes=0&cid=27c1207b06c7b0bf&ts=7115&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 400,\n \"transactionStatus\": \"FAILED\",\n \"transactionId\": 12345,\n \"originatingTransactionId\": \"XXXXX\",\n \"recipient\": {\n \"customerFullName\": \"Landry Ngoya\",\n \"customerEmailAdress\": \"N/A\",\n \"walletID\": \"+24399XXXXXXX\"\n },\n \"provider\": {\n \"libelle\": \"AIRTEL\",\n \"picture\": \"service-logos/airtelmoney.png\"\n },\n \"cost\": {\n \"amount\": 20000,\n \"frais\": 0,\n \"total\": 20000,\n \"currency\": \"CDF\"\n },\n \"motif\": \"Transfert vers Momo\",\n \"date\": \"17-01-2025 15:57\"\n}"}],"_postman_id":"8c17e029-728d-4577-9af7-cba6fc756bb9"}],"id":"8b19e241-ec11-4302-bfd1-cae935e8d21d","description":"The B2C Transfer module of MaishaPay allows merchants and businesses to make direct money transfers to their customers' Mobile Money wallets or credit card accounts. This feature is particularly useful for refunds, salary payments, or customer rewards.
\nMaishaPay operates in several countries, including the Democratic Republic of Congo (DRC), Congo-Brazzaville, Cameroon, Senegal, Côte d’Ivoire, Benin, Togo, Mali, and Burkina Faso, ensuring broad coverage for money transfers.
\n","_postman_id":"8b19e241-ec11-4302-bfd1-cae935e8d21d"},{"name":"Transaction Lookup","item":[{"name":"Search by ID","id":"d214317d-c4e2-4d7b-abcf-02e19be10a7c","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://marchand.maishapay.online/api/transaction/rest/v2/check","description":"The Transaction Lookup module allows merchants to retrieve the status and details of a specific transaction. This process can be performed in two ways:
\nSearch by MaishaPay ID: The unique identifier generated by MaishaPay and provided in the initial response.
\nSearch by Merchant Reference: The unique reference provided by the merchant when submitting the initial request.
\nThis lookup applies to all types of transactions, whether they are collections (via Mobile Money or card) or B2C transfers. The result includes comprehensive details about the transaction, such as its status, amount, recipient, and more.
\nURL: https://marchand.maishapay.online/api/transaction/rest/v2/check
URL: https://marchand.maishapay.online/api/transaction/rest/v2/check?useRef=1
HTTP Method: POST
\n{\n \"gatewayMode\": 1,\n \"publicApiKey\": \"MP-LIVEPK-XXXXX\",\n \"secretApiKey\": \"MP-LIVEPK-XXXXX\",\n \"transactionId\": \"123456\"\n}\n\n{\n \"gatewayMode\": 1,\n \"publicApiKey\": \"MP-LIVEPK-XXXXX\",\n \"secretApiKey\": \"MP-LIVEPK-XXXXX\",\n \"transactionId\": \"XXXX\"\n}\n\n{\n \"transaction_type\": \"C2B | Collect\",\n \"status_code\": 200,\n \"transactionStatus\": \"SUCCESS\",\n \"transactionId\": 123456,\n \"originatingTransactionId\": \"XXXX\",\n \"order\": {\n \"customerFullName\": null,\n \"customerPhoneNumber\": \"976002329\",\n \"customerEmailAdress\": null,\n \"cost\": {\n \"amount\": 1,\n \"frais\": 0.03,\n \"total\": 1.03,\n \"currency\": \"USD\"\n }\n },\n \"paymentChannel\": {\n \"channel\": \"CARD\",\n \"provider\": \"VISA\"\n },\n \"walletID\": \"97XXXXXXX\",\n \"created_at\": \"27-07-2023 12:41\",\n \"updated_at\": \"27-07-2023 12:43\"\n}\n\ntransaction_type: Type of transaction (C2B | Collect indicates a collection).
status_code: HTTP response code (200 for success).
\ntransactionStatus: Final status of the transaction (SUCCESS in this case).
Customer Details: Information about the customer who made the transaction (name, phone number, email).
\nPayment:
\nAmount paid (amount), fees (frais), total (total), and currency (currency).
Payment channel used (CARD) and provider (VISA).
Timestamps: Creation and update dates of the transaction.
\n{\n \"transaction_type\": \"B2C | Transfert\",\n \"status_code\": 400,\n \"transactionStatus\": \"FAILED\",\n \"transactionId\": 12345,\n \"originatingTransactionId\": \"XXXXX\",\n \"recipient\": {\n \"customerFullName\": \"Landry Ngoya\",\n \"customerEmailAdress\": null,\n \"walletID\": \"+24399XXXXXXX\"\n },\n \"provider\": {\n \"libelle\": \"AIRTEL\",\n \"picture\": \"service-logos/airtelmoney.png\"\n },\n \"cost\": {\n \"amount\": 20000,\n \"frais\": 0,\n \"total\": 20000,\n \"currency\": \"CDF\"\n },\n \"motif\": \"Transfert vers Momo\",\n \"date\": \"17-01-2025 16:26\"\n}\n\ntransaction_type: Type of transaction (B2C | Transfert indicates a B2C transfer).
status_code: HTTP response code (400 for failure).
\ntransactionStatus: Final status of the transaction (FAILED in this case).
Recipient Details:
\ncustomerFullName), email (customerEmailAdress), and wallet ID (walletID).Payment:
\namount), fees (frais), total (total), and currency (currency).Provider: Information about the Mobile Money operator (name and logo).
\nMotif: Description or reason for the transfer.
\nDate: Date of the transaction.
\nThe lookup module provides a robust and flexible solution for querying transactions, whether by MaishaPay ID or merchant reference. It enables merchants to confirm the statuses and details of transactions in real time.
\n","urlObject":{"path":["transaction","rest","v2","check"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[{"id":"8a62ec50-e259-4370-86c6-80cd10d40c16","name":"Via Référence Marchand","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"gatewayMode\" : 1,\r\n \"publicApiKey\" : \"MP-LIVEPK-XXXXX\",\r\n \"secretApiKey\" : \"MP-LIVEPK-XXXXX\",\r\n \"transactionId\" :\"XXXX\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://marchand.maishapay.online/api/transaction/rest/v2/check?useRef=1","host":["https://marchand.maishapay.online/api"],"path":["transaction","rest","v2","check"],"query":[{"key":"useRef","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2025 18:27:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"26b51e0b962b3916721523dfacccbc03"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"26b51e0b962b3916721523dfacccbc03"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=4ZQIrUmaSk%2B9tLL956CIOIe1kUEPa20m6lu94fQ2WoLFDSI4w2SAN1Cpx%2Bz7hLyGPQbdMPdzUjkKwef97MogCZB3AdOlIG6WELEVjc2zD3pffLENpFjK7qYLCRZmkfnBsLtM9i2UXW4lEVJq\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"903866e318ba03ca-LIS"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=102722&min_rtt=102201&rtt_var=39368&sent=4&recv=4&lost=0&retrans=0&sent_bytes=2824&recv_bytes=1295&delivery_rate=27074&cwnd=251&unsent_bytes=0&cid=30cc55ffb61f761c&ts=1850&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"transaction_type\": \"B2C | Transfert\",\n \"status_code\": 400,\n \"transactionStatus\": \"FAILED\",\n \"transactionId\": 12345,\n \"originatingTransactionId\": \"XXXX\",\n \"recipient\": {\n \"customerFullName\": \"Landry Ngoya\",\n \"customerEmailAdress\": null,\n \"walletID\": \"+24399XXXXXXX\"\n },\n \"provider\": {\n \"libelle\": \"AIRTEL\",\n \"picture\": \"service-logos/airtelmoney.png\"\n },\n \"cost\": {\n \"amount\": 20000,\n \"frais\": 0,\n \"total\": 20000,\n \"currency\": \"CDF\"\n },\n \"motif\": \"Transfert vers Momo\",\n \"date\": \"17-01-2025 16:26\"\n}"},{"id":"372e00cd-3d3e-4e24-a435-ed9171d325b8","name":"via l'ID de MaishaPay","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"gatewayMode\" : 1,\r\n \"publicApiKey\" : \"MP-LIVEPK-XXXXX\",\r\n \"secretApiKey\" : \"MP-LIVEPK-XXXXX\",\r\n \"transactionId\" :\"123456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/transaction/rest/v2/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2025 18:30:27 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"7d91b8ab6caea77728858bd21564b4a9"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"7d91b8ab6caea77728858bd21564b4a9"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=15ZBJHxqW179Hs6Paolps6JbWCaAZ8VpMiAgy8GvjXFydOhS6WfIFIjqiJwz%2BgqoAjrvnJZ%2BRMM5NAf8XGl6Pwxtvk7xx%2FFXMHTsHaSKl0Tzbl6UVdC3Vx0s4ddDv8Pq3EIMYYvkfosSp25f\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90386aa4ab08489d-LIS"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=102424&min_rtt=101672&rtt_var=39631&sent=4&recv=4&lost=0&retrans=0&sent_bytes=2824&recv_bytes=1281&delivery_rate=26743&cwnd=248&unsent_bytes=0&cid=c5a17a66c02a5fdf&ts=390&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"transaction_type\": \"C2B | Collect\",\n \"status_code\": 200,\n \"transactionStatus\": \"SUCCESS\",\n \"transactionId\": 123456,\n \"originatingTransactionId\": \"XXXX\",\n \"order\": {\n \"customerFullName\": null,\n \"customerPhoneNumber\": \"976002329\",\n \"customerEmailAdress\": null,\n \"cost\": {\n \"amount\": 1,\n \"frais\": 0.03,\n \"total\": 1.03,\n \"currency\": \"USD\"\n }\n },\n \"paymentChannel\": {\n \"channel\": \"CARD\",\n \"provider\": \"VISA\"\n },\n \"walletID\": \"97XXXXXXX\",\n \"created_at\": \"27-07-2023 12:41\",\n \"updated_at\": \"27-07-2023 12:43\"\n}"}],"_postman_id":"d214317d-c4e2-4d7b-abcf-02e19be10a7c"}],"id":"f1d05da6-5240-4027-b80f-974fbc1f836a","description":"The Transaction Lookup module allows merchants to verify the status and details of a transaction, regardless of its type: collection via Mobile Money, collection via card, B2C transfer, etc.
\nTwo options are available for performing this lookup:
\nBy Transaction ID: A unique identifier generated by MaishaPay and returned in the initial responses.
\nBy Merchant Reference: A unique reference provided by the merchant when submitting their request.
\nThis module provides full visibility into transactions and enables merchants to confirm statuses in case of doubts or delays in notifications.
\n","_postman_id":"f1d05da6-5240-4027-b80f-974fbc1f836a"},{"name":"Balance","item":[{"name":"Balance Repport","id":"3ac80150-32df-44b8-835f-e31784ad87ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://marchand.maishapay.online/api/wallet/balance/report","description":"URL: https://marchand.maishapay.online/api/wallet/balance/report
HTTP Method: POST
{\n \"gatewayMode\": 1,\n \"publicApiKey\": \"MP-LIVEPK-kK6yCY09V1jxxxxxxxxxx\",\n \"secretApiKey\": \"MP-LIVEPK-TpJWW05QUG$xxxxxxxxxx\",\n \"wallet\": \"Transfert\",\n \"currency\": \"CDF\"\n}\n\n{\n \"merchant\": \"EXCOTECH\",\n \"gatewayMode\": \"LIVE\",\n \"wallet\": \"Transfert\",\n \"solde\": 1154100,\n \"currency\": \"CDF\"\n}\n\nmerchant: Name of the merchant.
\ngatewayMode: Gateway mode (LIVE or SANDBOX).
\nwallet: Service concerned (e.g., Transfert, Collect).
\nsolde: Available balance for the specified service and currency.
\ncurrency: Currency of the returned balance (e.g., CDF).
\nFinancial Tracking: Merchants can quickly check available funds for each service before initiating a new transaction.
\nMulti-Currency Management: Multi-currency support enables efficient balance management across different regions.
\nThe Balance module provides merchants with a quick and secure way to check their balances by service and currency. This module is essential for effective fund management and complete transparency of available resources.
\n","urlObject":{"path":["wallet","balance","report"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[{"id":"96fb81d8-3d66-41f9-a084-dc0c68f90ac2","name":"Réponse Succès","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"gatewayMode\" : \"1\", // Gateway mode 1: Production; 0: Sandbox\r\n \"publicApiKey\" : \"MP-LIVEPK-kK6yCY09V1jxxxxxxxxxx\" , // your public API key, required|string',\r\n \"secretApiKey\" : \"MP-LIVEPK-TpJWW05QUG$xxxxxxxxxx\" , // your secret API key, required|string',\r\n \"wallet\" :\"Transfert\", // required : 'Collect'|'Transfert'|'Airtime'|'PayTv'\r\n \"currency\" : \"CDF\" // required : CDF, USD, XAF, XOF, ....\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/wallet/balance/report"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 17 Jan 2025 19:04:38 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"ca77cd067fb26b8e7219fe133a573937"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"58"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"ca77cd067fb26b8e7219fe133a573937"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=%2B3656F%2FoZupjnD3dweQo19uVpw3yl5W1KqAoYYeer4Q5LVR3s51qQk36eILGON%2FLrsRIEZZjyMzrwCubIcQc3oFTyp3o1JEgqqFeDxVEiTf49zcFxG8nA%2FzEW6ac%2Fu0mpKrKxuHiytQnaojk\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90389cb1988f6917-LIS"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=109048&min_rtt=101651&rtt_var=43006&sent=41&recv=39&lost=0&retrans=0&sent_bytes=4680&recv_bytes=1991&delivery_rate=27776&cwnd=254&unsent_bytes=0&cid=9cc620fccaeca9d8&ts=38223&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"merchant\": \"EXCOTECH\",\n \"gatewayMode\": \"LIVE\",\n \"wallet\": \"Transfert\",\n \"solde\": 1154100,\n \"currency\": \"CDF\"\n}"}],"_postman_id":"3ac80150-32df-44b8-835f-e31784ad87ee"}],"id":"eaa11f13-78fd-4224-b7ca-b413acb4e907","description":"The Balance module allows merchants to view their available balances for each service offered by MaishaPay, including:
\nCollection (Collect)
\nTransfers (Transfert)
\nMobile Recharge (Airtime)
\nTV Payments (PayTv)
\nBalances are also categorized by currency (USD, CDF, XAF, XOF, etc.), providing a clear and detailed overview of the funds available for each service type and currency. This module is essential for the effective financial resource management of merchants.
\n","_postman_id":"eaa11f13-78fd-4224-b7ca-b413acb4e907"},{"name":"PayTV","item":[{"name":"List of TV Operators","id":"8afd6666-8f34-4724-af24-5fe101a0dba9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://marchand.maishapay.online/api/paytv/operators","description":"The List of TV Operators module allows merchants to obtain a detailed list of pay-TV operators supported by MaishaPay in the Democratic Republic of Congo (DRC).
\nFor each operator, the merchant receives:
\nThe operator's name.
\nThe operator's logo for visual integration.
\nThe status (e.g., active or disabled).
\nSupported currencies (e.g., CDF, USD).
\nCountry-specific information (e.g., country code, national currency).
\nURL: https://marchand.maishapay.online/api/paytv/operators
HTTP Method: GET
{\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"libelle\": \"Canal+ RDC\",\n \"logo\": \"service-logos/canal+_rdc.png\",\n \"status\": \"enabled\",\n \"devises\": [\n {\n \"id\": 3,\n \"libelle\": \"Dollars Américains\",\n \"code\": \"USD\",\n \"symbole\": \"$\"\n },\n {\n \"id\": 1,\n \"libelle\": \"Francs Congolais\",\n \"code\": \"CDF\",\n \"symbole\": \"Fc\"\n }\n ],\n \"pays\": {\n \"nom_fr_fr\": \"République Démocratique du Congo\",\n \"alpha2\": \"CD\",\n \"callingCodes\": \"+243\"\n }\n },\n ...\n ]\n}\n\nCanal+ RDC
\nCurrencies: Congolese Francs (CDF), US Dollars (USD).
\nStatus: Active (enabled).
\nEASY TV
\nCurrencies: Congolese Francs (CDF), US Dollars (USD).
\nStatus: Active (enabled).
\nStartimes RDC
\nCurrencies: Congolese Francs (CDF).
\nStatus: Active (enabled).
\nDSTV
\nCurrencies: Congolese Francs (CDF), US Dollars (USD).
\nStatus: Active (enabled).
\nThis module is useful for:
\nObtaining the complete list of active operators.
\nChecking the supported currencies for each operator.
\nEasily integrating operator logos for a better user experience in merchant applications or websites.
\nThe List of TV Operators module provides a centralized and detailed view of active operators, ensuring smooth integration of payments for pay-TV services in the DRC.
\n","urlObject":{"path":["paytv","operators"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[{"id":"ce3601ff-a1d7-405a-9fd2-f57409adac37","name":"résultat détaillés","originalRequest":{"method":"GET","header":[],"url":"https://marchand.maishapay.online/api/paytv/operators"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 19 Jan 2025 18:24:55 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"daee129d5a71309510bd118775860e1c"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"daee129d5a71309510bd118775860e1c"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=6Q9Nc%2BskQPPUmqziz6l7S%2BSTQfiWLSOe1ZXNLCZEtlZ9r%2B6un86WLO%2FmwvxBOvX4HwcUgRL8ShpDDOcaGy4wH6vc7n8EJnIRxwh0oy19Pvf5E0lx7rvxl3aJsQ47dAEmZKjCNMfSomfQMEuf\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"9048dd44cfd2063a-CDG"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=130216&min_rtt=129079&rtt_var=50680&sent=4&recv=4&lost=0&retrans=0&sent_bytes=2823&recv_bytes=834&delivery_rate=20842&cwnd=252&unsent_bytes=0&cid=2035c17c5c247685&ts=1276&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"libelle\": \"Canal+ RDC\",\n \"logo\": \"service-logos/canal+_rdc.png\",\n \"status\": \"enabled\",\n \"pay_id\": 1,\n \"devises\": [\n {\n \"id\": 3,\n \"libelle\": \"Dollars Américains\",\n \"code\": \"USD\",\n \"symbole\": \"$\",\n \"pivot\": {\n \"tv_operator_id\": 1,\n \"devise_id\": 3\n }\n },\n {\n \"id\": 1,\n \"libelle\": \"Francs Congolais\",\n \"code\": \"CDF\",\n \"symbole\": \"Fc\",\n \"pivot\": {\n \"tv_operator_id\": 1,\n \"devise_id\": 1\n }\n }\n ],\n \"pays\": {\n \"id\": 1,\n \"code\": 180,\n \"alpha2\": \"CD\",\n \"alpha3\": \"COD\",\n \"nom_en_gb\": \"The Democratic Republic Of The Congo\",\n \"nom_fr_fr\": \"République Démocratique du Congo\",\n \"continent\": \"Africa\",\n \"currencyCode\": \"CDF\",\n \"currencyName\": \"Franc Congolais\",\n \"currencySymbol\": \"CDF\",\n \"flag\": \"https://s3.amazonaws.com/rld-flags/cd.svg\",\n \"callingCodes\": \"+243\"\n }\n }\n // ...\n ]\n}"}],"_postman_id":"8afd6666-8f34-4724-af24-5fe101a0dba9"},{"name":"Retrieve Operator Details","id":"194d4134-1e6b-4ee6-a830-1d8ec41139df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://marchand.maishapay.online/api/paytv/operators/1/show","description":"The Retrieve Operator Details module allows merchants to view detailed information about a specific TV operator by providing its identifier (id).
The details include:
\nThe operator's name.
\nThe operator's logo for visual integration.
\nThe operator's status (e.g., active or disabled).
\nThe currencies supported by the operator (e.g., CDF, USD).
\nCountry-specific information where the operator is active (e.g., name, code, flag, etc.).
\nURL: https://marchand.maishapay.online/api/paytv/operators/{id}/show
HTTP Method: GET
Retrieve Complete Information: Fetch precise data about an operator to customize the user experience (e.g., dynamic display).
\nCurrency Verification: Check the available currencies for payments with a specific operator.
\nManagement and Integration: Simplify the integration of operator-specific information into payment applications or platforms.
\nThis module provides exhaustive details about an operator, ensuring smooth management and better integration of payments for TV services.
\n","urlObject":{"path":["paytv","operators","1","show"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[{"id":"dfe9dcbf-5a04-4b1a-b568-702c95bfae85","name":"détails opérateur","originalRequest":{"method":"GET","header":[],"url":"https://marchand.maishapay.online/api/paytv/operators/1/show"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 19 Jan 2025 19:04:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"51f07a4a48985c37b49cf6fb2e422f71"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"51f07a4a48985c37b49cf6fb2e422f71"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=IJpBPUprajF0d36BypagmZeNcyI7UBLXUYb2a1FXuFfGkb0KU5W335hh4AMy2jQGGOGWJpchMKQXdbVO3wx82OIa1no2voibGgXEEpz7sF3nHSHv28bThkph6N9IopkCAQ1dTr4lDU7KLC5U\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"904917191f380496-CDG"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=135895&min_rtt=135388&rtt_var=51785&sent=4&recv=4&lost=0&retrans=0&sent_bytes=2824&recv_bytes=841&delivery_rate=20652&cwnd=251&unsent_bytes=0&cid=4db3cc0682f12bcf&ts=1326&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"data\": {\n \"id\": 1,\n \"libelle\": \"Canal+ RDC\",\n \"logo\": \"service-logos/canal+_rdc.png\",\n \"status\": \"enabled\",\n \"pay_id\": 1,\n \"devises\": [\n {\n \"id\": 3,\n \"libelle\": \"Dollars Américains\",\n \"code\": \"USD\",\n \"symbole\": \"$\",\n \"pivot\": {\n \"tv_operator_id\": 1,\n \"devise_id\": 3\n }\n },\n {\n \"id\": 1,\n \"libelle\": \"Francs Congolais\",\n \"code\": \"CDF\",\n \"symbole\": \"Fc\",\n \"pivot\": {\n \"tv_operator_id\": 1,\n \"devise_id\": 1\n }\n }\n ],\n \"pays\": {\n \"id\": 1,\n \"code\": 180,\n \"alpha2\": \"CD\",\n \"alpha3\": \"COD\",\n \"nom_en_gb\": \"The Democratic Republic Of The Congo\",\n \"nom_fr_fr\": \"République Démocratique du Congo\",\n \"continent\": \"Africa\",\n \"currencyCode\": \"CDF\",\n \"currencyName\": \"Franc Congolais\",\n \"currencySymbol\": \"CDF\",\n \"flag\": \"https://s3.amazonaws.com/rld-flags/cd.svg\",\n \"callingCodes\": \"+243\"\n }\n }\n}"}],"_postman_id":"194d4134-1e6b-4ee6-a830-1d8ec41139df"},{"name":"Packages by TV Operator","id":"f9c93ba2-e61c-4ed8-8589-7f5aa058ae77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://marchand.maishapay.online/api/paytv/operators/1/bouquets","description":"The Retrieve List of Available Bouquets by TV Operator module allows merchants to obtain the packages offered by a specific TV operator. Each package includes:
\nThe name of the package (libelle).
The available subscription periods (e.g., monthly, quarterly).
\nThe prices for each period, expressed in the supported currencies (e.g., CDF, USD).
\nThe variable {operatorID} corresponds to the ID of the TV operator for which the packages are to be retrieved.
URL: https://marchand.maishapay.online/api/paytv/operators/{operatorID}/bouquets
HTTP Method: GET
TV Offer Management: Lists all packages and their associated pricing for a specific operator.
\nCustomization: Facilitates the dynamic integration of TV offers into a merchant's application or website.
\nPrice Verification: Provides a precise view of package prices based on the available currencies.
\nThis module simplifies access to detailed information about TV packages by operator, enabling seamless integration and an enhanced user experience.
\n","urlObject":{"path":["paytv","operators","1","bouquets"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[{"id":"37341ec4-2a5b-4859-a782-677e541f6c67","name":"Détails des bouquets","originalRequest":{"method":"GET","header":[],"url":"https://marchand.maishapay.online/api/paytv/operators/1/bouquets"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 19 Jan 2025 19:11:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"18f1fe576b95e8368a2b8d18f50592d3"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"59"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"18f1fe576b95e8368a2b8d18f50592d3"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=0pmWrsjFBzIZDyGCCtGofyl1MbAxICfp8ArAT3csU%2FemZGTninaTb2hUCvFYOVwc96uUO%2BEOLYUhxb0gqCiNjyu8nqWQckaLkyJo0ByvurWo65Og23U2PNOpASTG8kUGjGdPkwuQ8Xqwuvnj\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90492133989922a3-CDG"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=134131&min_rtt=133590&rtt_var=51178&sent=4&recv=4&lost=0&retrans=0&sent_bytes=2825&recv_bytes=845&delivery_rate=20881&cwnd=251&unsent_bytes=0&cid=0eecbc2573d004dd&ts=1324&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"data\": [\n {\n \"id\": 1,\n \"libelle\": \"ACCESS\",\n \"tv_operator_id\": 1,\n \"tv_periodes\": [\n {\n \"id\": 3,\n \"libelle\": \"Mois\",\n \"pivot\": {\n \"bouquet_id\": 1,\n \"tv_periode_id\": 3,\n \"prix\": 10,\n \"devise_id\": 3\n }\n },\n {\n \"id\": 3,\n \"libelle\": \"Mois\",\n \"pivot\": {\n \"bouquet_id\": 1,\n \"tv_periode_id\": 3,\n \"prix\": 25000,\n \"devise_id\": 1\n }\n }\n ]\n }\n\n // ...\n ]\n}"}],"_postman_id":"f9c93ba2-e61c-4ed8-8589-7f5aa058ae77"},{"name":"Package Details","id":"e89463b3-04c4-492b-b24f-e8c35ed530f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://marchand.maishapay.online/api/paytv/bouquets/1/show","description":"The Bouquet Details module allows merchants to retrieve comprehensive information about a specific package offered by a TV operator. This information includes:
\nThe name of the package (libelle).
Available subscription periods (e.g., monthly, annual) along with their associated prices.
\nPricing based on supported currencies (e.g., CDF, USD).
\nDetails of the TV operator offering the package, such as its name, logo, and supported currencies.
\nURL: https://marchand.maishapay.online/api/paytv/operators/{operatorID}/bouquets/{bouquetID}
HTTP Method: GET
Dynamic Display: Enables the presentation of detailed package information in a merchant's application or website.
\nPrice Management: Provides access to package prices based on subscription periods and available currencies.
\nOperator Integration: Includes operator details, facilitating customization of the user experience.
\nThis module ensures detailed access to package information, enabling seamless integration and better management of TV offers for merchants.
\n","urlObject":{"path":["paytv","bouquets","1","show"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[{"id":"386df71d-b8ef-456e-9a7e-535bf220399f","name":"détails d'un bouquet","originalRequest":{"method":"GET","header":[],"url":"https://marchand.maishapay.online/api/paytv/bouquets/1/show"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 19 Jan 2025 19:18:24 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"edge-cache-engine","value":"varnish"},{"key":"edge-request-id","value":"951939a2e5f877f5c99945e317c98e57"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"x-ratelimit-limit","value":"60"},{"key":"x-ratelimit-remaining","value":"58"},{"key":"access-control-allow-origin","value":"*"},{"key":"vary","value":"Accept-Encoding"},{"key":"edge-cache-engine-mode","value":"ACTIVE"},{"key":"Age","value":"0"},{"key":"x-request-id","value":"951939a2e5f877f5c99945e317c98e57"},{"key":"edge-cache-engine-hit","value":"MISS"},{"key":"cf-cache-status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=qbg9d%2FB64%2BFQECutQM1QMkirJGuggsLNVWPqr%2BNhypRpc5u8VEzoEUvFxfzMlUZyvaEcLpz88e4gbuqQZ1PbMo%2FZdGlfOg%2FZDuE5hZHgPqzPwg2YB4NIPrbjcm8NATc4KgpLAuh4yGrizFHr\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"90492ba00f11f100-CDG"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"},{"key":"server-timing","value":"cfL4;desc=\"?proto=TCP&rtt=135356&min_rtt=127839&rtt_var=50794&sent=15&recv=13&lost=0&retrans=0&sent_bytes=4645&recv_bytes=1102&delivery_rate=23320&cwnd=254&unsent_bytes=0&cid=48b51cfc6f48e808&ts=10297&x=0\""}],"cookie":[],"responseTime":null,"body":"{\n \"status_code\": 200,\n \"data\": {\n \"id\": 1,\n \"libelle\": \"ACCESS\",\n \"tv_operator_id\": 1,\n \"tv_periodes\": [\n {\n \"id\": 3,\n \"libelle\": \"Mois\",\n \"pivot\": {\n \"bouquet_id\": 1,\n \"tv_periode_id\": 3,\n \"prix\": 10,\n \"devise_id\": 3\n }\n },\n {\n \"id\": 3,\n \"libelle\": \"Mois\",\n \"pivot\": {\n \"bouquet_id\": 1,\n \"tv_periode_id\": 3,\n \"prix\": 25000,\n \"devise_id\": 1\n }\n }\n ],\n \"tv_operator\": {\n \"id\": 1,\n \"libelle\": \"Canal+ RDC\",\n \"logo\": \"service-logos/canal+_rdc.png\",\n \"status\": \"enabled\",\n \"pay_id\": 1,\n \"devises\": [\n {\n \"id\": 3,\n \"libelle\": \"Dollars Américains\",\n \"code\": \"USD\",\n \"symbole\": \"$\",\n \"pivot\": {\n \"tv_operator_id\": 1,\n \"devise_id\": 3\n }\n },\n {\n \"id\": 1,\n \"libelle\": \"Francs Congolais\",\n \"code\": \"CDF\",\n \"symbole\": \"Fc\",\n \"pivot\": {\n \"tv_operator_id\": 1,\n \"devise_id\": 1\n }\n }\n ],\n \"pays\": {\n \"id\": 1,\n \"code\": 180,\n \"alpha2\": \"CD\",\n \"alpha3\": \"COD\",\n \"nom_en_gb\": \"The Democratic Republic Of The Congo\",\n \"nom_fr_fr\": \"République Démocratique du Congo\",\n \"continent\": \"Africa\",\n \"currencyCode\": \"CDF\",\n \"currencyName\": \"Franc Congolais\",\n \"currencySymbol\": \"CDF\",\n \"flag\": \"https://s3.amazonaws.com/rld-flags/cd.svg\",\n \"callingCodes\": \"+243\"\n }\n }\n }\n}"}],"_postman_id":"e89463b3-04c4-492b-b24f-e8c35ed530f3"},{"name":"https://marchand.maishapay.online/api/paytv/store","id":"a902b0fd-019b-494f-8ab5-2b4970c2218d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionReference\" : \"524HYG\",\r\n \"gatewayMode\": \"1\", // 0:SANDBOX, 1:LIVE \r\n \"publicApiKey\" : \"MP-LIVEPK-kK6yCY09V1j/3X4UTIWYWc092Wrf.7XqX/02APnoJQXRl$cs$V0X$Umlc3qshIULdX$1I5O8mz5jhZ$mmTTGyCnOtSRkOLS5AWwkFus0Cpeic.rCPcg1b2$H\", // 'required', your public API key\r\n \"secretApiKey\" : \"MP-LIVEPK-TpJWW05QUG$$qsjh7bcyye2Lu..zUF$O19NmSnTA3y$oGC$yuYZ4q7A7Hx2yA1Q0rzBw5/b8Z0tgGVG1FiaUb17yVNweyrkX04O9DSELs7k$tO1yHBXwFOgH\", //'required', your secret API key\r\n \"operation\" : \"reabonnement\", // 'required', 'abonnement | reabonnement',\r\n \"operator\" : \"1\", // 'required|numeric', operator Id\r\n \"bouquet\" : \"2\", // 'required|numeric', Bouuet Id\r\n \"periode\" : \"3\", // 'required|numeric', periode Id\r\n \"currency\" : \"USD\", // 'required' currency code : CDF|USD\r\n \"numCard\" : \"1236547895684125\" // 'required' operator card number\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/paytv/store","description":"Abonnement | réabonnement PayTv
\n","urlObject":{"path":["paytv","store"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a902b0fd-019b-494f-8ab5-2b4970c2218d"}],"id":"d2003bcd-c26f-44d1-bfb3-cae35c48a848","description":"The PayTV API allows developers to integrate payment functionalities for pay-TV services directly into their applications or websites. This service enables users to pay for subscriptions or purchase on-demand content seamlessly.
\nCurrently, the PayTV service is operational only in the Democratic Republic of Congo (DRC), supporting the following providers:
\nCANAL+ RDC
\nEASY TV
\nSTARTIMES RDC
\nDSTV
\nThis module simplifies payment management for television services and ensures a smooth user experience.
\n","_postman_id":"d2003bcd-c26f-44d1-bfb3-cae35c48a848"},{"name":"Airtimes","item":[{"name":"https://marchand.maishapay.online/api/airtime/operators","id":"90880986-f575-4b9a-825a-18f4fa5c8bf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"publicApiKey\": \"MP-LIVEPK-xxx\", // your public API key\r\n \"secretApiKey\" : \"MP-LIVEPK-xxx\", //your secret API key\r\n \"currency\":\"USD\" // CDF|USD\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/airtime/operators","description":"Recuperer la liste de touts les operateurs mobiles disponible pour le Airtime repartient dans plus de 175 pays.
\n","urlObject":{"path":["airtime","operators"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"90880986-f575-4b9a-825a-18f4fa5c8bf3"},{"name":"https://marchand.maishapay.online/api/airtime/operators/getByID/currency","id":"2fcfd30e-390f-4098-9f52-a815f5a68d24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"publicApiKey\": \"MP-LIVEPK-kK6yCY09V1j/3X4UTIWYWc092Wrf.7XqX/02APnoJQXRl$cs$V0X$Umlc3qshIULdX$1I5O8mz5jhZ$mmTTGyCnOtSRkOLS5AWwkFus0Cpeic.rCPcg1b2$H\", // your public API key\r\n \"secretApiKey\" : \"MP-LIVEPK-TpJWW05QUG$$qsjh7bcyye2Lu..zUF$O19NmSnTA3y$oGC$yuYZ4q7A7Hx2yA1Q0rzBw5/b8Z0tgGVG1FiaUb17yVNweyrkX04O9DSELs7k$tO1yHBXwFOgH\", //your secret API key\r\n \"currency\":\"USD\", // CDF|USD\r\n \"operatorId\" : 7077 //ID de l'operateur Vodacom RDC\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/airtime/operators/getByID/currency","description":"Recuperer les déatils d'un opérateur grâce à son identifiant et à la dévise d ela transaction
\n","urlObject":{"path":["airtime","operators","getByID","currency"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fcfd30e-390f-4098-9f52-a815f5a68d24"},{"name":"https://marchand.maishapay.online/api/airtime/operators/country/currency","id":"20110777-d24b-4398-adfa-f167538a0c79","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"publicApiKey\": \"MP-LIVEPK-xxx\", // your public API key\r\n \"secretApiKey\" : \"MP-LIVEPK-xxx\", //your secret API key\r\n \"currency\":\"USD\", // CDF|USD\r\n \"isoCode\" : \"CD\" // CD = République Démocratiue du Congo\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/airtime/operators/country/currency","description":"Recuperer la liste des opérateurs correspondant à un pays grâce au code ISO à deux chiffre correspondan au pays. ex.: \"CD\":pour la RDC
\n","urlObject":{"path":["airtime","operators","country","currency"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"20110777-d24b-4398-adfa-f167538a0c79"},{"name":"https://marchand.maishapay.online/api/airtime/operators/auto-detect/phone/country/currency","id":"e818d3a1-479e-4cbc-8bfb-dd88d60f0a63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"publicApiKey\": \"MP-LIVEPK-kK6yCY09V1j/3X4UTIWYWc092Wrf.7XqX/02APnoJQXRl$cs$V0X$Umlc3qshIULdX$1I5O8mz5jhZ$mmTTGyCnOtSRkOLS5AWwkFus0Cpeic.rCPcg1b2$H\", // your public API key\r\n \"secretApiKey\" : \"MP-LIVEPK-TpJWW05QUG$$qsjh7bcyye2Lu..zUF$O19NmSnTA3y$oGC$yuYZ4q7A7Hx2yA1Q0rzBw5/b8Z0tgGVG1FiaUb17yVNweyrkX04O9DSELs7k$tO1yHBXwFOgH\", //your secret API key\r\n \"currency\":\"USD\", // CDF|USD\r\n \"isoCode\" : \"CD\", // CD = République Démocratiue du Congo\r\n \"phone\" : \"+243854225000\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/airtime/operators/auto-detect/phone/country/currency","description":"Détecter l'operateur à partir d'un numéro de téléphone (+243 81 xxx xxxx) ainsi ue du code IS0 du pays correspondant.
\n","urlObject":{"path":["airtime","operators","auto-detect","phone","country","currency"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e818d3a1-479e-4cbc-8bfb-dd88d60f0a63"},{"name":"https://marchand.maishapay.online/api/airtime/store","id":"0d1e43db-2b21-4bdf-a0d2-7029be80b624","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"transactionReference\" : \"589\",\r\n \"gatewayMode\": \"0\", // 0:SANDBOX, 1:LIVE \r\n \"publicApiKey\": \"MP-SBPK-ZJWUtCHeGH5D2RECCkCRKJAvmTciEU1Qkv15y.m4.yAPEeByFbpJQyjvJ6kmfSYeb$$sK.86rw$iZa8j0WyRb$RD7ZgVqA4y$AX092Cik7DJsy6p$XDZ8.qL\", // your public API key\r\n \"secretApiKey\" : \"MP-SBPK-4BYwkLZsnwnJwBKBm$7qrVlEFjVszg1S$b4ncvOv4$y/QNn2r5X1dRMyREIXcO3SImFpxnLluas0Rp07yy$2rhZy3GaE2duHWSam$aUdCRDToCkW1$Eo3QhR\", //your secret API key\r\n \"currency\":\"CDF\", // CDF|USD\r\n \"motif\" : \"achat crédit\",\r\n \"amount\" : \"3000\",\r\n \"operatorId\":\"707\",\r\n \"recipient\":\r\n {\r\n \"countryCode\":\"CD\",\r\n \"phone\":\"+243814225000\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://marchand.maishapay.online/api/airtime/store","description":"Achat Airtime
\n","urlObject":{"path":["airtime","store"],"host":["https://marchand.maishapay.online/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d1e43db-2b21-4bdf-a0d2-7029be80b624"}],"id":"9b401ed9-5224-4b99-be83-2d77ea2824f4","_postman_id":"9b401ed9-5224-4b99-be83-2d77ea2824f4","description":""}],"event":[{"listen":"prerequest","script":{"id":"8874b402-4ca2-47e1-9dee-c6eb83247d97","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4c833378-3d1c-451b-a28b-02abbf638cff","type":"text/javascript","exec":[""]}}],"variable":[{"key":"Base_Url","value":"https://marchand.maishapay.online/api"}]}