README

Note This package supports Laravel versions 10, 11, and 12.

This package provides a simple and easy-to-use Laravel wrapper for the Midtrans API.

Installation

You can install the package via composer:

composer require bliss-jaspis/laravel-midtrans

You must publish the configuration file with:

php artisan vendor:publish --provider="BlissJaspis\Midtrans\Providers\MidtransServiceProvider" --tag="config"

This will create a config/midtrans.php file in your config directory.

Add the following to your .env file:

MIDTRANS_SERVER_KEY=your-api-key
MIDTRANS_CLIENT_KEY=your-client-key
MIDTRANS_IS_PRODUCTION=false

Usage

You can use facade Midtrans to use this package.

use BlissJaspis\Midtrans\Facades\Midtrans;

class YourController
{
    // ...

    public function getToken()
    {
        $token = Midtrans::creditCard()->getToken([
            'card_number' => '4355084355084358',
            'card_exp_month' => '07',
            'card_exp_year' => '2025',
            'card_cvv' => '123',
            'client_key' => config('midtrans.client_key'),
            'token_id' => '1234567890',
        ]);

        return $token;
    }

    public function chargeQRIS()
    {
        $charge = Midtrans::chargeTransaction([
            'payment_type' => 'qris',
            'transaction_details' => [
                'order_id' => '1234567890',
                'gross_amount' => 10000,
            ],
            'item_details' => [
                [
                    'id' => '1234567890',
                    'price' => 10000,
                    'quantity' => 1,
                ]
            ],
            'customer_details' => [
                'first_name' => 'John',
                'last_name' => 'Doe',
                'email' => 'john.doe@example.com',
                'phone' => '081234567890',
            ],
            'qris': [
                'acquirer' => 'gopay'
            ]
        ]);
    }

    public function refundTransaction()
    {
        Midtrans::gopay()->refundTransaction('order-id-123', [
            'amount' => 50000,
            'refund_key' => '1234567890',
            'reason' => 'Item out of stock',
        ]);

        // Or you can use the trait Base to refund transaction
        // This method is recommended to use if you want to refund transaction without knowing the payment type
        Midtrans::refundTransaction('order-id-123', [
            'refund_key' => 'my-refund-key',
            'amount' => 50000,
            'reason' => 'Item out of stock',
        ]);
    }

    public function cancelTransaction()
    {
        Midtrans::creditCard()->cancelTransaction('order-id-123');

        // Or you can use the trait Base to cancel transaction
        // This method is recommended to use if you want to cancel transaction without knowing the payment type
        Midtrans::cancelTransaction('order-id-456');
    }

    public function translateTransactionStatus()
    {
        $status = Midtrans::translateTransactionStatus('capture');
        return $status;
    }

    public function translateFraudStatus()
    {
        $status = Midtrans::translateFraudStatus('accept');
        return $status;
    }
}

Available Methods

Midtrans

• cancelTransaction(string $transactionIdOrOrderId)
• refundTransaction(string $transactionIdOrOrderId, array $params)
• directRefundTransaction(string $transactionIdOrOrderId, array $params)
• chargeTransaction(array $params)
• captureTransaction(array $params)
• expireTransaction(string $transactionIdOrOrderId)
• getTransactionStatus(string $transactionIdOrOrderId)
• getTransactionStatusB2B(string $transactionIdOrOrderId)
• translateTransactionStatus(string $status)
• translateFraudStatus(string $status)
• creditCard()
• gopay()

Credit Card

• chargeTransaction(array $params)
• getToken(array $params)
• registerCard(array $params)
• getPointInquiry(string $cardToken)
• getBankIdentificationNumber(string $binNumber)
• cancelTransaction(string $transactionIdOrOrderId)
• refundTransaction(string $transactionIdOrOrderId, array $params)
• directRefundTransaction(string $transactionIdOrOrderId, array $params)
• createSubscription(array $params)
• getSubscription(string $subscriptionId)
• disableSubscription(string $subscriptionId)
• enableSubscription(string $subscriptionId)
• updateSubscription(string $subscriptionId, array $params)

Gopay

• chargeTransaction(array $params)
• createPayAccount(array $params)
• getAccountLinkedStatus(string $accountId)
• unbindAccount(string $accountId)
• cancelTransaction(string $transactionIdOrOrderId)
• refundTransaction(string $transactionIdOrOrderId, array $params)
• directRefundTransaction(string $transactionIdOrOrderId, array $params)
• createSubscription(array $params)
• getSubscription(string $subscriptionId)
• disableSubscription(string $subscriptionId)
• enableSubscription(string $subscriptionId)
• updateSubscription(string $subscriptionId, array $params)

API Reference

For more detailed information about the API endpoints, parameters, and response structures, please refer to the official Midtrans API Documentation.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Bliss Jaspis
• All Contributors

License

The MIT License (MIT). Please see License File for more information.