Midtrans

https://docs.midtrans.com/reference/
Admin
Midtrans is a payment processing platform that enables businesses to accept and send payments online...
Tokens:404,016
Snippets:2,608
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start Compass Response Examples

Source: https://docs.midtrans.com/reference/list-of-jssdks-gopay-container-v4

JSON response structures for compass initiation, event data, and error scenarios.

```JSON
{
    "success": true,
    "ret": "GP_SUCCESS",
		"msg": "COMPASS_STARTED"
}
```

```JSON
{
    direction: double, // The value due north between [0,360)
    timestamp: int64
}
```

```JSON
{
    "success": false,
    "errorCode": "",
    "errorType": "JS_BRIDGE_ERROR",
    "errorMessage": "",
    "ret": "GP_EXCEPTION"   
}
```

--------------------------------

### Pre-signed URL Example

Source: https://docs.midtrans.com/reference/getpresignedurls-5

Example of a pre-signed URL string used for document access.

```json
"https://al-ky-id-s-esign-service.oss-ap-southeast-5.aliyuncs.com/CERT_REG/5e021eb4-d875-47bb-817b-8b1782f0c3bb_SELFIE?X-Amz-Security-Token=CAIS2QJ1q6Ft5B2yfSjIr5qGIPziqKpwxZuhMVbXsWoCadtn3I%2FzhTz2IHhMfHhsBO0Wsv0ymGFY5v8ZlrF0TZJGVEeBdchrq80IrlP4ONqe45TusOdcIEJ%2B4ODIWXDBx8b3T7jTbrG0I4WACT3tkit03sGJF1GLVECkNpukkINuas9tMCCzcTtBAqU9RGIg0rh4U0HcLvGwKBXnr3PNBU5zwGpGhHh49L60z7%2F3iHOcriWnk7VL996gc8P6MJI8YsshabrvgrwmJpim%2BTVL9h1H%2BJ1xiKF54jrdtrmfeQIJu03Xb7eJooE2cVMoNvhjQLQ5oeP9mvs9oeHJiYX8xlNEJfkQXD%2FfVD5KeEodqgbI3L8bAlWbUxylurjnXhL14xI4yxkQfYXGL2%2BrztOklfiAbnC7TOHusRvhOTzIMIP%2Bi7otmrEOtG7D5rfkaibJLfz3vihwpGvXWx1AX3YagAEc9cDzjyTiGa4217on4KanvDDLEM4S4R1v%2F7i0SSRVa8c4LTrGA28YjM3dv3e%2BYTVLzunP0PT7e8T5JSstO0Mhoi127g2u2ahJRxYrPEfGlOk6NycJNS345QM1k%2BKwVBetpUwWDNf8nosT16O2KjykrmXq66XrGmg6oiKKTUFmHiAA&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260507T110754Z&X-Amz-SignedHeaders=host&X-Amz-Credential=LTAI5tK86mktEnBbhjUrMadp%2F20260507%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Expires=432000&X-Amz-Signature=9580cba19e5929c2a250eef3f5637571478d27142444bcf33a3fa53c34938884"
```

--------------------------------

### Get Profile API Response Examples

Source: https://docs.midtrans.com/reference/get-profile-gopay-container

Examples of successful and error response payloads returned by the Get Profile endpoint.

```json
{
  "success": true,
  "error": {},
  "data": {
    "phone_number": "+628210072773",
    "email": "example@gmail.com",
    "name": "example",
  }
}
```

```json
{
  "success": false,
  "error": {
    "code": "105",
    "description": "User not found"
  }
}
```

--------------------------------

### Install dependencies via Cocoapods

Source: https://docs.midtrans.com/reference/ios-sdk

Command to install the defined pods in your project.

```bash
pod install
```

--------------------------------

### Presigned URL Response Example

Source: https://docs.midtrans.com/reference/getpresignedurls-5

Example of a successful response body containing the presigned URL, document reference, and expiry time.

```json
"documentUrl": "https://al-ky-id-s-esign-service.oss-ap-southeast-5.aliyuncs.com/CERT_REG/5e021eb4-d875-47bb-817b-8b1782f0c3bb_SELFIE?X-Amz-Security-Token=CAIS2QJ1q6Ft5B2yfSjIr5qGIPziqKpwxZuhMVbXsWoCadtn3I%2FzhTz2IHhMfHhsBO0Wsv0ymGFY5v8ZlrF0TZJGVEeBdchrq80IrlP4ONqe45TusOdcIEJ%2B4ODIWXDBx8b3T7jTbrG0I4WACT3tkit03sGJF1GLVECkNpukkINuas9tMCCzcTtBAqU9RGIg0rh4U0HcLvGwKBXnr3PNBU5zwGpGhHh49L60z7%2F3iHOcriWnk7VL996gc8P6MJI8YsshabrvgrwmJpim%2BTVL9h1H%2BJ1xiKF54jrdtrmfeQIJu03Xb7eJooE2cVMoNvhjQLQ5oeP9mvs9oeHJiYX8xlNEJfkQXD%2FfVD5KeEodqgbI3L8bAlWbUxylurjnXhL14xI4yxkQfYXGL2%2BrztOklfiAbnC7TOHusRvhOTzIMIP%2Bi7otmrEOtG7D5rfkaibJLfz3vihwpGvXWx1AX3YagAEc9cDzjyTiGa4217on4KanvDDLEM4S4R1v%2F7i0SSRVa8c4LTrGA28YjM3dv3e%2BYTVLzunP0PT7e8T5JSstO0Mhoi127g2u2ahJRxYrPEfGlOk6NycJNS345QM1k%2BKwVBetpUwWDNf8nosT16O2KjykrmXq66XrGmg6oiKKTUFmHiAA&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20260507T110754Z&X-Amz-SignedHeaders=host&X-Amz-Credential=LTAI5tK86mktEnBbhjUrMadp%2F20260507%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Expires=432000&X-Amz-Signature=9580cba19e5929c2a250eef3f5637571478d27142444bcf33a3fa53c34938884",
                            "documentReference": "5e021eb4-d875-47bb-817b-8b1782f0c3bb_SELFIE",
                            "expiryInSeconds": "432000"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
```

--------------------------------

### Show Authorization Guide

Source: https://docs.midtrans.com/reference/list-of-jssdks-webview-v4

Displays a guide to the user regarding specific permissions, such as access to the address book.

```Javascript
var params = {
  	    permission: 'Address book'
  		  cancelbutton: 'Cancel'
        };

window.gpContainer.call(  
  "GPUIDialog",  
  "showAuthGuide",  
  params,  
  function(response) {  
    console.log('success:', response);  
  },  
  function(error) {  
    console.log('error:', error);  
  }  
);
```

```JSON
{
    "success": true,
		"ret": "GP_SUCCESS"
}
```

```JSON
{
    "success": false,
    "errorCode": "",
    "errorType": "JS_BRIDGE_ERROR",
    "errorMessage": "",
    "ret": "GP_EXCEPTION"   
}
```

--------------------------------

### Initialize Mini AppSDK

Source: https://docs.midtrans.com/reference/frontend-apis

Import and initialize the SDK, using a dummy service when not in a production environment.

```Javascript
import MiniAppSDK from '@gopay/miniapp-client';

const inProductionEnvironment = import.meta.env.PROD;

const miniAppSdk = new MiniAppSDK({useDummyService: !inProductionEnvironment});
```

--------------------------------

### Get Pay Account API Response Samples

Source: https://docs.midtrans.com/reference/get-pay-account

Examples of JSON responses returned by the Get Pay Account endpoint for various account statuses.

```json
{
  "status_code": "201",
  "payment_type": "gopay",
  "account_id": "00000269-7836-49e5-bc65-e592afafec14",
  "account_status": "PENDING"
}
```

```json
{
  "status_code": "204",
  "payment_type": "gopay",
  "account_id": "00000269-7836-49e5-bc65-e592afafec14",
  "account_status": "EXPIRED"
}
```

```json
{
  "status_code": "200",
  "payment_type": "gopay",
  "account_id": "00000269-7836-49e5-bc65-e592afafec14",
  "account_status": "ENABLED",
  "metadata": {
    "payment_options": [
      {
        "name": "GOPAY_WALLET",
        "active": true,
        "balance": {
          "value": "1000000.00",
          "currency": "IDR"
        },
        "metadata": {},
        "token": "eyJ0eXBlIjogIkdPUEFZX1dBTExFVCIsICJpZCI6ICIifQ=="
      },
      {
        "name": "PAY_LATER",
        "active": true,
        "balance": {
          "value": "350000.00",
          "currency": "IDR"
        },
        "metadata": {},
        "token": "eyJ0eXBlIjogIlBBWV9MQVRFUiIsICJpZCI6ICIifQ=="
      }
    ]
  }
}
```

```json
{
  "status_code": "204",
  "payment_type": "gopay",
  "account_id": "00000269-7836-49e5-bc65-e592afafec14",
  "account_status": "DISABLED"
}
```

--------------------------------

### Initialize MidtransKit SDK

Source: https://docs.midtrans.com/reference/ios-sdk

Configure the SDK in AppDelegate using your client key, environment, and merchant server URL.

```swift
//AppDelegate
import MidtransKit

MidtransConfig.shared().setClientKey("VT-CLIENT-sandbox-client-key", environment: .sandbox, merchantServerURL: "https://merchant-url-sandbox.com")
```

```objectivec
//AppDelegate.m
#import <MidtransKit/MidtransKit.h>

[[MidtransConfig shared] setClientKey:@"VT-CLIENT-sandbox-client-key"
   environment:MidtransServerEnvironmentSandbox
 merchantServerURL:@"https://merchant-url-sandbox.com"];
```

--------------------------------

### Implement Snap Callback JS

Source: https://docs.midtrans.com/reference/snap-js

A complete HTML example demonstrating how to load the Snap JS library and trigger the embed function with custom callback handlers.

```html
<html>

<head>
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- @TODO: replace SET_YOUR_CLIENT_KEY_HERE with your client key -->
  <script type="text/javascript"
		src="https://app.sandbox.midtrans.com/snap/snap.js"
    data-client-key="SET_YOUR_CLIENT_KEY_HERE"></script>
  <!-- Note: replace with src="https://app.midtrans.com/snap/snap.js" for Production environment -->
</head>

<body>
  <button id="pay-button">Pay!</button>

  <!-- @TODO: You can add the desired ID as a reference for the embedId parameter. -->
  <div id="snap-container"></div>

  <script type="text/javascript">
    // For example trigger on button clicked, or any time you need
    var payButton = document.getElementById('pay-button');
    payButton.addEventListener('click', function () {
      // Trigger snap popup. @TODO: Replace TRANSACTION_TOKEN_HERE with your transaction token.
      // Also, use the embedId that you defined in the div above, here.
      window.snap.embed('YOUR_SNAP_TOKEN', {
        embedId: 'snap-container',
        onSuccess: function (result) {
          /* You may add your own implementation here */
          alert("payment success!"); console.log(result);
        },
        onPending: function (result) {
          /* You may add your own implementation here */
          alert("wating your payment!"); console.log(result);
        },
        onError: function (result) {
          /* You may add your own implementation here */
          alert("payment failed!"); console.log(result);
        },
        onClose: function () {
          /* You may add your own implementation here */
          alert('you closed the popup without finishing the payment');
        }
      });
    });
  </script>
</body>

</html>
```

--------------------------------

### Initialize iOS SDK for Production

Source: https://docs.midtrans.com/reference/going-live-with-mobile-sdk

Set the client key and environment to production during SDK initialization.

```text
MidtransConfig.shared().setClientKey("merchant clientkey", environment: .production, merchantServerURL: "merchant server URL")
```

```objectivec
[CONFIG setClientKey:@"merchant clientkey"
                 environment:MidtransServerEnvironmentProduction
           merchantServerURL:@"merchant server production URL"];
```

--------------------------------

### OpenAPI Specification for Get Transaction Status B2B

Source: https://docs.midtrans.com/reference/get-transaction-status-b2b

The OpenAPI definition for the B2B transaction status endpoint, including security schemes and response examples.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "coreapi",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.sandbox.midtrans.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v2/{order_id}/status/b2b": {
      "get": {
        "summary": "Get Transaction Status B2B",
        "description": "",
        "operationId": "get-transaction-status-b2b",
        "parameters": [
          {
            "name": "order_id",
            "in": "path",
            "description": "order id or transaction_id",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"status_code\": \"200\",\n  \"status_message\": \"Success, transactions are retrieved\",\n  \"transactions\": [\n    {\n      \"payment_type\": \"echannel\",\n      \"bill_key\": \"990568881594\",\n      \"transaction_time\": \"2016-09-17 06:36:31\",\n      \"gross_amount\": \"6000.00\",\n      \"order_id\": \"vttesta73fb08ebd1-160916233631561\",\n      \"signature_key\": \"ae85d0ade1bcdfdce4400b63918a8250b3ce45056621c743f71c02197e851accae43787190ee343b18f665d811a4e4d372bddbd347bda588a90d89c1b1c4ed53\",\n      \"status_code\": \"200\",\n      \"transaction_id\": \"647c9366-596a-4ba2-b20f-77baaa1e6647\",\n      \"transaction_status\": \"settlement\",\n      \"fraud_status\": \"accept\",\n      \"status_message\": \"Success, transaction is found\"\n    },\n    {\n      \"payment_type\": \"echannel\",\n      \"bill_key\": \"990568881594\",\n      \"transaction_time\": \"2016-09-17 06:34:52\",\n      \"gross_amount\": \"6000.00\",\n      \"order_id\": \"vttesta73fb08ebd1\",\n      \"signature_key\": \"e8ae2f8cba40fe505c3c0f8bfec8dbc748ee5c8d04ad0699f33d17b7fc6aba5b1218f518226b4ea2ff095cb60125a5e6e1cb345608446378d29cb10ad687f560\",\n      \"status_code\": \"200\",\n      \"transaction_id\": \"f9a6684f-e3b4-46dd-8b6c-b61d805b3c6f\",\n      \"transaction_status\": \"settlement\",\n      \"fraud_status\": \"accept\",\n      \"status_message\": \"Success, transaction is found\"\n    }\n  ]\n}"
                  },
                  "Transaction doesn't exist": {
                    "value": "{\n    \"status_code\": \"404\",\n    \"status_message\": \"Transaction doesn't exist.\",\n    \"id\": \"ca1774d3-302a-4d47-8495-11524ee306b8\"\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "status_code": {
                          "type": "string",
                          "example": "200"
                        },
                        "status_message": {
                          "type": "string",
                          "example": "Success, transactions are retrieved"
                        },
                        "transactions": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "payment_type": {
                                "type": "string",
                                "example": "echannel"
                              },
                              "bill_key": {
                                "type": "string",
                                "example": "990568881594"
                              },
                              "transaction_time": {
                                "type": "string",
                                "example": "2016-09-17 06:36:31"
                              },
                              "gross_amount": {
                                "type": "string",
                                "example": "6000.00"
                              },
                              "order_id": {
                                "type": "string",
                                "example": "vttesta73fb08ebd1-160916233631561"
                              },
                              "signature_key": {
                                "type": "string",
                                "example": "ae85d0ade1bcdfdce4400b63918a8250b3ce45056621c743f71c02197e851accae43787190ee343b18f665d811a4e4d372bddbd347bda588a90d89c1b1c4ed53"
                              },
                              "status_code": {
                                "type": "string",
                                "example": "200"
                              },
                              "transaction_id": {

```

--------------------------------

### Get Subscription Success Responses

Source: https://docs.midtrans.com/reference/get-subscription

Successful retrieval returns a subscription object with an active status. Examples are provided for both Card and GoPay payment types.

```json
{
  "id": "d98a63b8-97e4-4059-825f-0f62340407e9",
  "name": "MONTHLY_2019",
  "amount": "14000",
  "currency": "IDR",
  "created_at": "2019-05-29T09:11:01.810452",
  "schedule": {
    "interval": 1,
    "interval_unit": "month",
    "current_interval" : 1,
    "start_time": "2019-05-29T09:11:01.803677",
    "previous_execution_at": "2019-05-29T09:11:01.803677",
    "next_execution_at": "2019-06-29T09:11:01.803677"
  },
  "status": "active",
  "token": "48111111sHfSakAvHvFQFEjTivUV1114",
  "payment_type": "credit_card",
  "transaction_ids": [
    "9beb839d-8fe2-41ec-bc5e-045e5001d286",
    "eb47cd5d-acd3-4e53-a155-7bd41aa38052",
    "9d286585-bd19-43be-95dc-da3d32ab18af",
    "ec3175c6-9f0a-4ce5-9332-abfb1db0852f",
    "00f7d40d-26e2-4624-a797-9ddc54ca9987",
    "421bd123-d8b2-4476-bcea-165f9e176cbb"
  ],
  "metadata": {
    "description": "Recurring payment for A"
  },
  "customer_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "johndoe@email.com",
    "phone": "+62812345678"
  }
}
```

```json
{
  "id": "d98a63b8-97e4-4059-825f-0f62340407e9",
  "name": "MONTHLY_2019",
  "amount": "14000",
  "currency": "IDR",
  "created_at": "2019-05-29T09:11:01.810452",
  "schedule": {
    "interval": 1,
    "interval_unit": "month",
	  "current_interval" : 1,
    "start_time": "2019-05-29T09:11:01.803677",
    "previous_execution_at": "2019-05-29T09:11:01.803677",
    "next_execution_at": "2019-06-29T09:11:01.803677"
  },
  "status": "active",
  "token": "48111111sHfSakAvHvFQFEjTivUV1114",
  "payment_type": "credit_card",
  "metadata": {
    "description": "Recurring payment for A"
  },
  "customer_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "johndoe@email.com",
    "phone": "+62812345678"
  },
  "gopay": {                                                    
    "account_id": "phy56f8f-2683-4248-8080-e59b36c6bbgf"
  }
}
```

--------------------------------

### JSON Request Body for Card Payment

Source: https://docs.midtrans.com/reference/credit-card

Example of a JSON payload for initiating a credit card transaction, including optional installment and dynamic descriptor settings.

```json
{
  "transaction_details": {
    "order_id": "ORDER-101",
    "gross_amount": 10000
  },
  "item_details": [{
    "id": "ITEM1",
    "price": 10000,
    "quantity": 1,
    "name": "Midtrans Bear",
    "brand": "Midtrans",
    "category": "Toys",
    "merchant_name": "Midtrans"
  }],
  "customer_details": {
    "first_name": "TEST",
    "last_name": "MIDTRANSER",
    "email": "test@midtrans.com",
    "phone": "+628123456"
  },
  "enabled_payments": ["credit_card"],
  "credit_card": {
    "save_card": true,
    "secure": true,
    "channel": "migs",
    "bank": "maybank",
    "installment": {
      "required": false,
      "terms": {
        "bni": [3, 6, 12],
        "mandiri": [3, 6, 12],
        "cimb": [3],
        "bca": [3, 6, 12],
        "offline": [6, 12]
      }
    },
    "whitelist_bins": [
      "48111111",
      "41111111",
      "bni"
    ],
    "dynamic_descriptor": {
      "merchant_name" : "Fuji Apple Inc",
      "city_name": "Jakarta",
      "country_code": "ID"
    }
  }
}
```

--------------------------------

### Manage Loading State with snap.show and snap.hide

Source: https://docs.midtrans.com/reference/snap-js

Demonstrates using show and hide to provide loading feedback while asynchronously fetching a payment token.

```javascript
function ajaxGetToken(transactionData, callback){
    var snapToken;
    // Request get token to your server & save result to snapToken variable

    if(snapToken){
      callback(null, snapToken);
    } else {
      callback(new Error('Failed to fetch snap token'),null);
    }
}

payButton.onclick(function(){
  snap.show();
  ajaxGetToken(transactionData, function(error, snapToken){
    if(error){
      snap.hide();
    } else {
      snap.pay(snapToken);
    }
  });
});
```

--------------------------------

### Transaction Status API Responses

Source: https://docs.midtrans.com/reference/get-transaction-status-card

Examples of successful JSON responses from the Get Status API, covering standard successful transactions and various refund scenarios.

```json
{
  "status_code" : "200",
  "status_message" : "Success, Credit Card transaction is successful",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "48111111-1114",
  "order_id" : "example-1424936368",
  "payment_type" : "credit_card",
  "transaction_time" : "2015-02-26 14:39:33",
  "transaction_status" : "capture",
  "fraud_status" : "accept",
  "approval_code" : "1424936374393",
  "signature_key" : "2802a264cb978fbc59f631c68d120cbda8dc853f5dfdc52301c615cf4f14e7a0b09aa...",
  "bank" : "bni",
  "gross_amount" : "30000.00",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit",
  "reference_id": "DL-dduIy7XtGtvxJtNNpOfbAt",
  "channel": "dragon",
  "expiry_time":"2015-03-06 14:39:33",
  "settlement_time":"2015-02-26 16:00:00"
}
```

```json
{
  "status_code" : "200",
  "status_message" : "Success, refund request is approved by the bank",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "48111111-1114",
  "order_id" : "example-1424936368",
  "payment_type" : "credit_card",
  "transaction_time" : "2015-02-26 14:39:33",
  "transaction_status" : "partial_refund",
  "fraud_status" : "accept",
  "approval_code" : "1424936374393",
  "signature_key" : "2802a264cb978fbc59f631c68d120cbda8dc853f5dfdc52301c615cf4f14e7a0b09aa...",
  "bank" : "bni",
  "gross_amount" : "30000.00",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit",
  "payment_option_type": "GOPAY_WALLET",
  "refund_amount": "12000.00",
  "refunds": [
    {
      "refund_chargeback_id": 1,
      "refund_amount": "5000.00",
      "created_at": "2015-02-27 00:14:20",
      "reason": "some reason",
      "refund_key": "reference1"
    },
    {
      "refund_chargeback_id": 2,
      "refund_amount": "7000.00",
      "created_at": "2015-02-28 01:23:15",
      "reason": "",
      "refund_key": "reference2"
    },
  ]
}
```

```json
{
  "status_code" : "200",
  "status_message" : "Success, refund request is approved by the bank",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "48111111-1114",
  "order_id" : "example-1424936368",
  "payment_type" : "credit_card",
  "transaction_time" : "2015-02-26 14:39:33",
  "transaction_status" : "partial_refund",
  "fraud_status" : "accept",
  "approval_code" : "1424936374393",
  "signature_key" : "2802a264cb978fbc59f631c68d120cbda8dc853f5dfdc52301c615cf4f14e7a0b09aa...",
  "bank" : "bni",
  "gross_amount" : "30000.00",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit",
  "payment_option_type": "GOPAY_WALLET",
  "refund_amount": "12000.00",
  "refunds": [
    {
      "refund_chargeback_id": 1,
      "refund_amount": "5000.00",
      "created_at": "2015-02-27 00:14:20",
      "reason": "some reason",
      "refund_key": "reference1",
      "refund_method": "online",
      "bank_confirmed_at": "2015-02-27 02:30:20"
    },
    {
      "refund_chargeback_id": 2,
      "refund_amount": "7000.00",
      "created_at": "2015-02-28 01:23:15",
      "reason": "",
      "refund_key": "reference2",
      "refund_method": "offline",
      "bank_confirmed_at": "2015-02-27 02:30:20"
    },
  ]
}
```

--------------------------------

### Full Snap.js Integration Example

Source: https://docs.midtrans.com/reference/frontend-integration-overview

A complete HTML structure demonstrating the inclusion of snap.js, the viewport meta tag, and the trigger for the snap.pay function.

```html
<html>
  <head>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script type="text/javascript"
            src="https://app.sandbox.midtrans.com/snap/snap.js"
            data-client-key="<CLIENT-KEY>"></script>
  </head>
  <body>
    <button id="pay-button">Pay!</button>
    <script type="text/javascript">
      var payButton = document.getElementById('pay-button');
      payButton.addEventListener('click', function () {
        snap.pay('<SNAP_TOKEN>');
      });
    </script>
  </body>
</html>
```

--------------------------------

### Online Installment Charge Request

Source: https://docs.midtrans.com/reference/card-feature-installment

This endpoint allows you to initiate an online installment payment by providing the card token and installment configuration.

```APIDOC
## POST /v2/charge

### Description
Initiates an online installment payment transaction using a previously generated card token.

### Method
POST

### Parameters
#### Request Body
- **payment_type** (string) - Required - Must be set to "credit_card".
- **transaction_details** (object) - Required - Contains order_id and gross_amount.
- **credit_card** (object) - Required - Contains card and installment details.
  - **token_id** (string) - Required - Token ID representing customer's card information.
  - **bank** (string) - Required - The name of the Acquiring Bank.
  - **installment_term** (integer) - Required - Installment tenure in months.

### Request Example
{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "credit_card": {
    "token_id": "< your token ID >",
    "bank": "bni",
    "installment_term": 12
  }
}
```

--------------------------------

### showAuthGuide

Source: https://docs.midtrans.com/reference/list-of-jssdks-webview-v4

Displays an authorization guide for permissions.

```APIDOC
## showAuthGuide

### Description
Displays a guide to the user explaining why a specific permission is required.

### Method
window.gpContainer.call("GPUIDialog", "showAuthGuide", params, successCallback, errorCallback)

### Parameters
- **permission** (string) - The name of the permission (e.g., 'Address book').
- **cancelbutton** (string) - Text for the Cancel button.

### Request Example
var params = { permission: 'Address book', cancelbutton: 'Cancel' };
window.gpContainer.call("GPUIDialog", "showAuthGuide", params, function(response) { console.log('success:', response); }, function(error) { console.log('error:', error); });
```

--------------------------------

### GPNavigator.launchUri

Source: https://docs.midtrans.com/reference/list-of-jssdks-gopay-container-v4

Launches a specified URI using the GoPay Container navigator.

```APIDOC
## GPNavigator.launchUri

### Description
Launches a specified URI via the GPNavigator interface.

### Parameters
- **uri** (string) - Required - The URI to be launched.

### Request Example
```javascript
var params = {
  uri: "string"
};

window.gpContainer.call("GPNavigator", "launchUri", params, callback, errorCallback);
```

### Response
#### Success Response
- **success** (boolean) - Indicates if the operation was successful.
- **ret** (string) - The return status code (e.g., GP_SUCCESS).

#### Error Response
- **success** (boolean) - False.
- **errorCode** (string) - The error code.
- **errorType** (string) - The type of error.
- **errorMessage** (string) - Description of the error.
- **ret** (string) - The return status code (e.g., GP_EXCEPTION).
```

--------------------------------

### Initiate Payment Flow with Snap Token

Source: https://docs.midtrans.com/reference/android-sdk

Use the Snap Token retrieved from your backend to launch the payment UI. The Kotlin example demonstrates handling the result via ActivityResultLauncher, while the Java example shows the legacy method call.

```kotlin
val launcher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
    if (result?.resultCode == RESULT_OK) {
        result.data?.let {
            val transactionResult = it.getParcelableExtra<TransactionResult>(UiKitConstants.KEY_TRANSACTION_RESULT)
            Toast.makeText(this,"${transactionResult?.transactionId}", Toast.LENGTH_LONG).show()
        }
    }
}

UiKitApi.getDefaultInstance().startPaymentUiFlow(
    this@MainActivity, // Activity
    launcher, // ActivityResultLauncher
    "25e3659b-f00c-4d98-bfff-9f72978c8df5" // Snap Token
)
```

```java
MidtransSDK.getInstance().startPaymentUiFlow(ACTIVITY_CONTEXT, SNAP_TOKEN);
```

--------------------------------

### Request Header Example

Source: https://docs.midtrans.com/reference/payment-notification-api

Example of the required HTTP headers for the notification request.

```http
Content-type:application/json
X-TIMESTAMP:2020-01-01T00:00:00+07:00
X-SIGNATURE: da1fa417c72d6b91c257e01e54fac824
X-PARTNER-ID: 
X-EXTERNAL-ID:12345678901234567890
```

--------------------------------

### Initialize Midtrans SDK

Source: https://docs.midtrans.com/reference/android-sdk

Initialize the SDK using the merchant BASE_URL and CLIENT_KEY defined in the build configuration.

```kotlin
UiKitApi.Builder()
        .withMerchantClientKey(CLIENT_KEY) // client_key is mandatory
        .withContext(CONTEXT) // context is mandatory
        .withMerchantUrl(BASE_URL) // set transaction finish callback (sdk callback)
        .enableLog(true) // enable sdk log (optional)
        .withFontFamily(ASSET_FONT) // set font family
        .withColorTheme(CustomColorTheme("#FFE51255", "#B61548", "#FFE51255")) // set theme. it will replace theme on snap theme on MAP ( optional)
        .build()
```

```java
SdkUIFlowBuilder.init()
  .setClientKey(CLIENT_KEY) // client_key is mandatory
  .setContext(CONTEXT) // context is mandatory
  .setTransactionFinishedCallback(new TransactionFinishedCallback() {
    	@Override
      public void onTransactionFinished(TransactionResult result) {
      	// Handle finished transaction here.
      }
    }) // set transaction finish callback (sdk callback)
  .setMerchantBaseUrl(BASE_URL) //set merchant url (required)
  .enableLog(true) // enable sdk log (optional)
  .setColorTheme(new CustomColorTheme("#FFE51255", "#B61548", "#FFE51255")) // set theme. it will replace theme on snap theme on MAP ( optional)
  .buildSDK();
```

--------------------------------

### Request Header Example

Source: https://docs.midtrans.com/reference/cancel-api

Example of the required HTTP headers for the cancellation request.

```text
X-TIMESTAMP 2022-03-04T08:02:09+07:00
X-SIGNATURE yqmBXZ3yV6NPG1LtwXMm3quXzJMRX5Ms+r9ebc5xWIZGSKbZL3Oy871GHb7WQUucLa5nxN/HcnZYoNHc+KkWTQ==
X-PARTNER-ID 668052e34f194aa8be79e15a21e4fc2f
X-EXTERNAL-ID 91919644194391346361915387229113
CHANNEL-ID 95221
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxMmUzODE4Mi00YjIxLTQ0YWMtOTVkNi1mMjFhMjEwZmIxZTAiLCJjbGllbnRJZCI6IjY2ODA1MmUzNGYxOTRhYThiZTc5ZTE1YTIxZTRmYzJmIiwibmJmIjoxNjYzODQwNTU5LCJleHAiOjE2NjM4NDE0NTksImlhdCI6MTY2Mzg0MDU1OX0.fEr0vIbB2kY8alZ-SROl3ftAFbfRd0uU-lGq9XuFi8M
Content-Type application/json
```

--------------------------------

### Start Accelerometer

Source: https://docs.midtrans.com/reference/frontend-v2

Initializes the accelerometer with a specified interval and sets up an event listener for motion data.

```Javascript
var params = {
/**
interval is either "game", "ui", or "normal". "normal" is default
"game" : 20ms
"ui": 60ms
"normal": 200ms
*/
  interval: 'normal'
};

window.gpContainer.call(  
  "GPMotion",  
  "startAccelerometer",  
  params,  
  function(response) {  
    console.log('success:', response);  
  },  
  function(error) {  
    console.log('error:', error);  
  }  
);

// Listen to Compass result
document.addEventListener('GPMotion.Event.accelerometer', (e: GPMotionAccelerometerData) => {
  console.log('Received gpAsyncCallback event:', JSON.stringify(e));
});
```

--------------------------------

### Request Header Example

Source: https://docs.midtrans.com/reference/payment-notification-api

Example of the required HTTP headers for the payment notification request.

```http
Content-type:application/json
X-TIMESTAMP:2020-01-01T00:00:00+07:00
X-SIGNATURE:da1fa417c72d6b91c257e01e54fac824
X-PARTNER-ID:G12345678
X-EXTERNAL-ID:12345678901234567890
```

--------------------------------

### Include gpContainer SDK

Source: https://docs.midtrans.com/reference/frontend-v2

Add this script tag to your HTML codebase to initialize the SDK.

```html
<script src="https://gwk.gopayapi.com/sdk/stable/gp-container.min.js"></script>
```

--------------------------------

### Request Header Example

Source: https://docs.midtrans.com/reference/payment-notification-api

Example of the required HTTP headers for the payment notification request.

```http
Content-type:application/json
X-TIMESTAMP:2024-03-19T14:30:00+07:00
X-SIGNATURE: da1fa417c72d6b91c257e01e54fac824
X-PARTNER-ID: 
X-EXTERNAL-ID:12345678901234567890
CHANNEL-ID:12345
```

--------------------------------

### Submission Valid Example

Source: https://docs.midtrans.com/reference/partnercallback-6

Example JSON response for a successfully completed and valid submission.

```json
"submissionId": "c64b4c8c-9a8f-4e9c-b86a-0908291c855e",
          "userId": "421453511adsasdl",
          "userIdType": "MY_USER_ID",
          "partnerSessionId": "b719f79b-ae7a-440a-8f9c-5f661ca34e7",
          "status": "COMPLETED",
          "result": "VALID",
          "submissionDetails": {
            "verificationResult": {
              "nik": "PASS",
              "name": "PASS",
              "dateOfBirth": "PASS",
              "selfie": "PASS"
            },
            "ktpData": {
              "nik": "3208201808850001",
              "name": "JOHN DOE",
              "region": "SEMARANG",
```

--------------------------------

### Initialize Midtrans SDK

Source: https://docs.midtrans.com/reference/android-sdk

Configure the SDK builder with your client key, context, and merchant URL. Ensure initialization occurs within your activity or application class.

```kotlin
UiKitApi.Builder()
        .withMerchantClientKey(CLIENT_KEY) // client_key is mandatory
        .withContext(CONTEXT) // context is mandatory
        .withMerchantUrl(BASE_URL) // set transaction finish callback (sdk callback)
        .enableLog(true) // enable sdk log (optional)
        .withFontFamily(ASSET_FONT)
        .withColorTheme(CustomColorTheme("#FFE51255", "#B61548", "#FFE51255"))
        .build()
setLocaleNew("en") //`en` for English and `id` for Bahasa

...

// function to set the SDK language
private fun setLocaleNew(languageCode: String?) {
    val locales = LocaleListCompat.forLanguageTags(languageCode)
    AppCompatDelegate.setApplicationLocales(locales)
}
```

```java
SdkUIFlowBuilder.init()
  .setClientKey(CLIENT_KEY) // client_key is mandatory
  .setContext(CONTEXT) // context is mandatory
  .setTransactionFinishedCallback(new TransactionFinishedCallback() {
    @Override
    public void onTransactionFinished(TransactionResult result) {
    	// Handle finished transaction here.
    }
  }) // set transaction finish callback (sdk callback)
  .setMerchantBaseUrl(BASE_URL) //set merchant url (required)
  .enableLog(true) // enable sdk log (optional)
  .setColorTheme(new CustomColorTheme("#FFE51255", "#B61548", "#FFE51255")) // set theme. it will replace theme on snap theme on MAP ( optional)
  .setLanguage("en") //`en` for English and `id` for Bahasa
  .buildSDK();
```

--------------------------------

### Request Header Example

Source: https://docs.midtrans.com/reference/get-transaction-status-api

Example of the required HTTP headers for the transaction status request.

```http
X-TIMESTAMP 2022-03-04T08:02:09+07:00
X-SIGNATURE yqmBXZ3yV6NPG1LtwXMm3quXzJMRX5Ms+r9ebc5xWIZGSKbZL3Oy871GHb7WQUucLa5nxN/HcnZYoNHc+KkWTQ==
X-PARTNER-ID 668052e34f194aa8be79e15a21e4fc2f
X-EXTERNAL-ID 91919644194391346361915387229113
CHANNEL-ID 12345
Authorization Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIxMmUzODE4Mi00YjIxLTQ0YWMtOTVkNi1mMjFhMjEwZmIxZTAiLCJjbGllbnRJZCI6IjY2ODA1MmUzNGYxOTRhYThiZTc5ZTE1YTIxZTRmYzJmIiwibmJmIjoxNjYzODQwNTU5LCJleHAiOjE2NjM4NDE0NTksImlhdCI6MTY2Mzg0MDU1OX0.fEr0vIbB2kY8alZ-SROl3ftAFbfRd0uU-lGq9XuFi8M
Content-Type application/json
```
Tokens:
Raw