Midtrans-PHP

Snap Redirect requires the customer to be redirected to a payment page hosted by Midtrans.

Workflow:

1. Backend: Call \Midtrans\Snap::createTransaction($params) to get a transaction object.
2. Redirect: Access the redirect_url property from the response and redirect the user's browser to that URL.

$params = array(
    'transaction_details' => array(
        'order_id' => rand(),
        'gross_amount' => 10000,
    )
);

try {
  // Get Snap Payment Page URL
  $paymentUrl = \Midtrans\Snap::createTransaction($params)->redirect_url;
  
  // Redirect to Snap Payment Page
  header('Location: ' . $paymentUrl);
}
catch (Exception $e) {
  echo $e->getMessage();
}

If you are not using Composer, download or clone the repository and manually require the Midtrans.php file in your project to enable autoloading.

require_once dirname(__FILE__) . '/pathofproject/Midtrans.php';

// my code goes here

Before making API calls, configure the global \Midtrans\Config settings. You must set your serverKey and decide whether to use the Sandbox (isProduction = false) or Production (isProduction = true) environment. You can also enable sanitization, 3DS for credit cards, and manage notification URLs.

// Set your Merchant Server Key
\Midtrans\Config::$serverKey = '<your server key>';
// Set to Development/Sandbox Environment (default). Set to true for Production Environment (accept real transaction).
\Midtrans\Config::$isProduction = false;
// Set sanitization on (default)
\Midtrans\Config::$isSanitized = true;
// Set 3DS transaction for credit card to true
\Midtrans\Config::$is3ds = true;

Alternatively, you can manually add the dependency to your composer.json file and run composer install.

{
    "require": {
        "midtrans/midtrans-php": "2.*
    }
}

You can run the project's test suite using PHPUnit.

To run integration tests that perform real transactions in the sandbox environment, ensure you have updated the server_key and client_key in your phpunit.xml file with your own Midtrans credentials.

Available test commands:

• Run all tests: vendor/bin/phpunit
• Run a specific test file: vendor/bin/phpunit tests/integration/CoreApiIntegrationTest.php

# Run all tests
vendor/bin/phpunit

# Run specific integration tests
vendor/bin/phpunit tests/integration/CoreApiIntegrationTest.php

When developing new e-commerce plug-ins for Midtrans, follow these critical guidelines:

1. Currency Handling: Midtrans v1 and v2 currently only accept payments in Indonesian Rupiah (IDR). The server validates that item prices are integers. If your system uses currencies other than IDR, convert them to IDR first. Do not round off prices before conversion; only round the price after it has been converted to IDR to ensure accuracy.
2. Auto-sanitization: Consider utilizing the auto-sanitization feature in your implementation.

Midtrans sends HTTP POST notifications to your configured URL whenever a transaction status changes.

To handle these, create a dedicated endpoint and use the \Midtrans\Notification class to parse the payload. You should check both transaction_status and fraud_status to determine the final state of the order in your database.

$notif = new \Midtrans\Notification();

$transaction = $notif->transaction_status;
$fraud = $notif->fraud_status;

if ($transaction == 'capture') {
    if ($fraud == 'challenge') {
      // Handle challenge
    }
    else if ($fraud == 'accept') {
      // Handle success
    }
}
// ... handle other statuses like 'cancel' or 'deny'

If you are using Composer, you can install the library using the CLI or by adding it to your composer.json file. This is the recommended method for modern PHP projects.

Note for Laravel users: If you encounter issues with autoloading, you may need to run composer dumpautoload. Once installed, the /Midtrans object will be available in your project via autoloading.

composer require midtrans/midtrans-php

You can customize the notification URLs sent by Midtrans for specific transactions.

• Use Config::$appendNotifUrl to add additional URLs alongside the ones configured in the Midtrans Dashboard Portal (MAP).
• Use Config::$overrideNotifUrl to use new URLs and disregard the settings in the Midtrans Dashboard Portal (MAP).

Constraints:

• You can provide a maximum of 3 URLs.
• If both appendNotifUrl and overrideNotifUrl are used, only overrideNotifUrl will be applied.

// Add new notification url(s) alongside the settings on Midtrans Dashboard Portal (MAP)
Config::$appendNotifUrl = "https://example.com/test1,https://example.com/test2";
// Use new notification url(s) disregarding the settings on Midtrans Dashboard Portal (MAP)
Config::$overrideNotifUrl = "https://example.com/test1";