Download the PHP package midtrans/midtrans-php without Composer

Midtrans-PHP

Midtrans :heart: PHP!

This is the Official PHP wrapper/library for Midtrans Payment API, that is compatible with Composer. Visit https://midtrans.com for more information about the product and see documentation at http://docs.midtrans.com for more technical details. Starting version 2.6, this library now supports Snap-bi. You can go to this docs to learn more about Snap-bi.

1. Installation

1.a Composer Installation

If you are using Composer, you can install via composer CLI:

or

add this require line to your composer.json file:

and run composer install on your terminal.

Note: If you are using Laravel framework, in some case you also need to run composer dumpautoload

/Midtrans will then be available (auto loaded) as Object in your Laravel project.

1.b Manual Instalation

If you are not using Composer, you can clone or download this repository.

Then you should require/autoload Midtrans.php file on your code.

2. How to Use

2.1 General Settings

Override Notification URL

You can opt to change or add custom notification urls on every transaction. It can be achieved by adding additional HTTP headers into charge request.

More details

Note: When both appendNotifUrl and overrideNotifUrl are used together then only overrideNotifUrl will be used.

Both header can only receive up to maximum of 3 urls.

Idempotency-Key

You can opt to add idempotency key on charge transaction. It can be achieved by adding additional HTTP headers into charge request. Is a unique value that is put on header on API request. Midtrans API accept Idempotency-Key on header to safely handle retry request without performing the same operation twice. This is helpful for cases where merchant didn't receive the response because of network issue or other unexpected error.

More details

2.2 Choose Product/Method

We have 3 different products of payment that you can use:

• doc ref
• doc ref
• doc ref

Choose one that you think best for your unique needs.

2.2.a Snap

You can see Snap example here.

Get Snap Token

Initialize Snap JS when customer click pay button

Implement Notification Handler

Refer to this section

2.2.b Snap Redirect

You can see some Snap Redirect examples here.

Get Redirection URL of a Payment Page

Implement Notification Handler

Refer to this section

2.2.c Core API (VT-Direct)

You can see some Core API examples here.

Set Client Key

Checkout Page

Please refer to this file

Checkout Process

1. Create Transaction Details

2. Create Item Details, Billing Address, Shipping Address, and Customer Details (Optional)

3. Get Token ID from Checkout Page

4. Create Transaction Data

5. Charge

6. Credit Card 3DS Authentication

The credit card charge result may contains redirect_url for 3DS authentication. 3DS Authentication should be handled on Frontend please refer to API docs

For full example on Credit Card 3DS transaction refer to:

• Core API examples

7. Handle Transaction Status

8. Implement Notification Handler

Refer to this section

2.3 Handle HTTP Notification

Create separated web endpoint (notification url) to receive HTTP POST notification callback/webhook. HTTP notification will be sent whenever transaction status is changed. Example also available here

2.4 Process Transaction

Get Transaction Status

Approve Transaction

If transaction fraud_status == CHALLENGE, you can approve the transaction from Merchant Dashboard, or API :

Cancel Transaction

You can Cancel transaction with fraud_status == CHALLENGE, or credit card transaction with transaction_status == CAPTURE (before it become SETTLEMENT)

Expire Transaction

You can Expire transaction with transaction_status == PENDING (before it become SETTLEMENT or EXPIRE)

Refund Transaction

Refund a transaction (not all payment channel allow refund via API) You can Refund transaction with transaction_status == settlement

Direct Refund Transaction

Refund a transaction via Direct Refund API You can Refund transaction with transaction_status == settlement

3. Snap-BI (*NEW FEATURE starting v2.6.0)

Standar Nasional Open API Pembayaran, or in short SNAP, is a national payment open API standard published by Bank Indonesia. To learn more you can read this docs

3.1 General Settings

3.2 Create Payment

3.2.1 Direct Debit (Gopay, Dana, Shopeepay)

Refer to this docs for more detailed information about creating payment using direct debit.

3.2.2 VA (Bank Transfer)

Refer to this docs for more detailed information about VA/Bank Transfer.

3.2.3 Qris

Refer to this docs for more detailed information about Qris.

3.4 Get Transaction Status

Refer to this docs for more detailed information about getting the transaction status.

3.5 Cancel Transaction

Refer to this docs for more detailed information about cancelling the payment.

3.6 Refund Transaction

Refer to this docs for more detailed information about refunding the payment.

3.7 Adding additional header / override the header

You can add or override the header value, by utilizing the ->withAccessTokenHeader or ->withTransactionHeader method chain. Refer to this docs to see the header value required by Snap-Bi , and see the default header on each payment method

3.8 Reusing Access Token

If you've saved your previous access token and wanted to re-use it, you can do it by utilizing the ->withAccessToken.

3.9 Payment Notification

To implement Snap-Bi Payment Notification you can refer to this docs To verify the webhook notification that you recieve you can use this method below

Unit Test

Integration Test (sandbox real transactions)

Please change server key and client key on phpunit.xml to your own.

All Test

vendor/bin/phpunit

Specific Test

vendor/bin/phpunit tests/integration/CoreApiIntegrationTest.php

Contributing

Developing e-commerce plug-ins

There are several guides that must be taken care of when you develop new plugins.

1. Handling currency other than IDR. Midtrans v1 and v2 currently accepts payments in Indonesian Rupiah only. As a corrolary, there is a validation on the server to check whether the item prices are in integer or not. As much as you are tempted to round-off the price, DO NOT do that! Always prepare when your system uses currencies other than IDR, convert them to IDR accordingly, and only round the price AFTER that.

2. Consider using the auto-sanitization feature.