.png%3Falt%3Dmedia%26token%3Dfedc0bc4-7860-4e24-8014-75dde0936148)
.png%3Falt%3Dmedia%26token%3Dfedc0bc4-7860-4e24-8014-75dde0936148)
Comment on page
MPGS
Mastercard Payment Gateway Services (MPGS) is a secure payment gateway that enables businesses to accept online payments from customers through various payment channels.
Pay the transaction.
post
https://api.plutus.ly/api/v1
/transaction/mpgs/confirm
Confirm (Pay)
Pay the transaction
Parameters
Header
Authorization*
Bearer: [Access token]
X-API-KEY*
API Key
Body
amount*
String
Transaction amount in US dollars.
Formatting is allowed with a maximum of two decimal places: XXX, XX.X, XX.XX
invoice_no*
String
Invoice number associated with transaction
return_url*
String
Redirect URL after completing the payments
customer_ip
String
[Optional] Customer IP address
lang
String
[Optional] Accepts ar or en, by default ar
Responses
200: OK
400: Bad Request
CURL
PHP
Plutu PHP Package
curl --location --request POST 'https://api.plutus.ly/api/v1/transaction/mpgs/confirm' \
--header 'X-API-KEY: [API_KEY]' \
--header 'Authorization: Bearer [ACCESS_TOKEN]' \
--form 'amount="[AMONUT]"' \
--form 'invoice_no="[INVOICE_NO]"' \
--form 'return_url="[RETURN_URL]"' \
--form 'customer_ip="[CUSTOMER_IP]"'
1
<?php
2
3
$curl = curl_init();
4
5
curl_setopt_array($curl, array(
6
CURLOPT_URL => 'https://api.plutus.ly/api/v1/transaction/mpgs/confirm',
7
CURLOPT_RETURNTRANSFER => true,
8
9
CURLOPT_CUSTOMREQUEST => 'POST',
10
CURLOPT_POSTFIELDS => array(
11
'amount' => '[AMONUT]',
12
'invoice_no' => '[INVOICE_NO]',
13
'return_url' => '[RETURN_URL]',
14
'customer_ip' => '[CUSTOMER_IP]'
15
),
16
CURLOPT_HTTPHEADER => array(
17
'X-API-KEY: [API_KEY]',
18
'Authorization: Bearer [ACCESS_TOKEN]'
19
),
20
));
21
22
$response = curl_exec($curl);
23
24
curl_close($curl);
25
echo $response;
1
<?php
2
3
use Plutu\Services\PlutuMpgs;
4
5
$amount = 5.0; // amount in float format
6
$invoiceNo = 'inv-12345'; // invoice number
7
$returnUrl = 'https://example.com/callback/handler'; // the url to handle the callback from plutu
8
9
try {
10
11
$api = new PlutuMpgs;
12
$api->setCredentials('api_key', 'access_token', 'secret_key');
13
$apiResponse = $api->confirm($amount, $invoiceNo, $returnUrl);
14
15
if ($apiResponse->getOriginalResponse()->isSuccessful()) {
16
17
// Redirect URL for Plutu checkout page
18
$redirectUrl = $apiResponse->getRedirectUrl();
19
20
// You should rediect the customer to payment checkout page
21
// header("location: " . $redirectUrl);
22
23
} elseif ($apiResponse->getOriginalResponse()->hasError()) {
24
25
// Possible errors from Plutu API
26
// @see https://docs.plutu.ly/api-documentation/errors Plutu API Error Documentation
27
$errorCode = $apiResponse->getOriginalResponse()->getErrorCode();
28
$errorMessage = $apiResponse->getOriginalResponse()->getErrorMessage();
29
$statusCode = $apiResponse->getOriginalResponse()->getStatusCode();
30
$responseData = $apiResponse->getOriginalResponse()->getBody();
31
32
}
33
34
// Handle exceptions that may be thrown during the execution of the code
35
// The following are the expected exceptions that may be thrown:
36
// Check the "Handle Exceptions and Errors" section for more details
37
//
38
// InvalidAccessTokenException, InvalidApiKeyException, InvalidSecretKeyException,
39
// InvalidAmountException, InvalidInvoiceNoException, InvalidReturnUrlException
40
} catch (\Exception $e) {
41
$exception = $e->getMessage();
42
}
The callback will be received from Plutu when the transaction is completed or canceled. This gives a Merchant better control of how the transaction is processed on the Merchant's side. This is useful e.g. when you want to mark an order as paid, update your shop's inventory, or add appropriate records to Merchant’s internal accounting system.
Callback response parameters:
The callback is called with HTTP GET and with the same query string parameters as in the redirect
Parameter | Description |
|---|---|
gateway | Gateway name: mpgs |
approved | It will only be returned if the transaction is approved and completed |
canceled | It will only be returned if the transaction is canceled by the customer |
amount | amount sent in the request |
currency | Transaction currency refers to the currency used for processing payments through MPGS and is configured in your Plutu account. It currently supports USD |
invoice_no | Invoice number sent in the pay request |
transaction_id | Plutu transaction id |
hashed | Hash message authorization code (HMAC) is used to verify both the data integrity and the authorization of a message. |
SHA-256 HMAC is calculated as follows:
- The SHA-256 HMAC calculation includes all response query string parameters and key-value pairs except the “hashed” parameter.
- Create an SHA-256 HMAC of the resultant string using the secret key created in the Plutu account and convert it to uppercase and compare it with the “hashed” parameter received in the callback.
Last modified 3mo ago