Midtrans

https://docs.midtrans.com/docs/
Admin
Midtrans is a payment gateway platform that enables businesses to accept multiple payment methods...
Tokens:326,195
Snippets:2,432
Trust Score:9.9
Update:3 days ago
Show doc for...
Tokens:
Raw
### Go Snap Installation and Import

Source: https://docs.midtrans.com/docs/snap-snap-integration-guide

Install the Go module and import the necessary packages.

```bash
go get -u github.com/midtrans/midtrans-go
```

```go
import (
    "github.com/midtrans/midtrans-go"
    "github.com/midtrans/midtrans-go/coreapi"
    "github.com/midtrans/midtrans-go/snap"
    "github.com/midtrans/midtrans-go/iris"
)
```

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

### Launch Feature Example

Source: https://docs.midtrans.com/docs/features

This example demonstrates how to build a FeatureRequest and invoke the launchFeature method with a FeatureCallback to handle completion or errors.

```Kotlin
val request = FeatureRequest.Builder()
    .requestId("REQ-${System.currentTimeMillis()}")
    .featureId("some-feature-id")
    .userCorrelationId("corr-5678")
    .token("host-app-token")
    .build()

sdk.getFeatureManager().launchFeature(
    activity = this,
    request = request,
    callback = object : FeatureCallback<LaunchResult> {
        override fun onComplete(result: LaunchResult, data: Map<String, Any?>) {
            Log.d(TAG, "Launched featureId: ${result.featureId}")
        }
        override fun onError(error: GoPayEnterpriseError) {
            Log.e(TAG, "Error ${error.code}: ${error.message}")
        }
    }
)
```

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

### Example Usage: verify flow

Source: https://docs.midtrans.com/docs/features

Example showing how to build a FeatureRequest, create a CredentialReceiver, and call sdk.getFeatureManager().verify() with a FeatureCallback.

```APIDOC
## Example Usage: verify flow

### Description
Demonstrates building a FeatureRequest, defining a CredentialReceiver, and invoking the verify method on the feature manager with a FeatureCallback.

### Code
```kotlin
val request = FeatureRequest.Builder()
    .requestId("REQ-${System.currentTimeMillis()}")
    .userCorrelationId("user-correlation-id")
    .token("short-term-linking-token")
    .additionalData(mapOf("phone_number" to "+628123456789"))
    .build()

val credentialReceiver = CredentialReceiver.Exchange { credential, requestId ->
    if (credential is GoPayCredential.AuthCode) {
        val correlationId = myBackend.exchangeAuthCode(credential.code, requestId)
        ExchangeResult.Success(userCorrelationId = correlationId)
    } else {
        ExchangeResult.Failure(reason = "Unexpected credential type")
    }
}

sdk.getFeatureManager().verify(
    activity = this,
    request = request,
    credentialReceiver = credentialReceiver,
    callback = object : FeatureCallback<VerifyResult> {
        override fun onComplete(result: VerifyResult, data: Map<String, Any?>) {
            Log.d(TAG, "Submission ID: ${result.submissionId}")
        }
        override fun onError(error: GoPayEnterpriseError) {
            Log.e(TAG, "Error ${error.code}: ${error.message}")
        }
    }
)
```
```

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

### Install Midtrans Python Client

Source: https://docs.midtrans.com/docs/coreapi-card-payment-integration

Use pip to install the Midtrans Python client library.

```bash
pip install midtransclient
```

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

### launchFeature example

Source: https://docs.midtrans.com/docs/features

Example usage of the SDK's feature manager to launch a feature with a FeatureRequest and handle the result via FeatureCallback.

```APIDOC
## launchFeature

### Description
Launches a feature using the SDK's feature manager. The result is returned to the FeatureCallback.onComplete method.

### Method
launchFeature

### Parameters
- **activity** (Activity) - Required - The activity context.
- **request** (FeatureRequest) - Required - The feature request containing requestId, featureId, userCorrelationId, and token.
- **callback** (FeatureCallback<LaunchResult>) - Required - Callback to receive the launch result or error.

### Request Example
```kotlin
val request = FeatureRequest.Builder()
    .requestId("REQ-${System.currentTimeMillis()}")
    .featureId("some-feature-id")
    .userCorrelationId("corr-5678")
    .token("host-app-token")
    .build()

sdk.getFeatureManager().launchFeature(
    activity = this,
    request = request,
    callback = object : FeatureCallback<LaunchResult> {
        override fun onComplete(result: LaunchResult, data: Map<String, Any?>) {
            Log.d(TAG, "Launched featureId: ${result.featureId}")
        }
        override fun onError(error: GoPayEnterpriseError) {
            Log.e(TAG, "Error ${error.code}: ${error.message}")
        }
    }
)
```

### Response
#### Success Response
- **result** (LaunchResult) - Contains the featureId of the launched feature.
- **data** (Map<String, Any?>) - Additional data returned with the result.

#### Error Response
- **error** (GoPayEnterpriseError) - Contains error code and message.

```

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

### GET /esign-partner/v1/submissions/urls

Source: https://docs.midtrans.com/docs/integrating-with-esign-products

Example of a GET request to the Esign API submissions URLs endpoint, demonstrating how to include the token and required headers.

```APIDOC
## GET /esign-partner/v1/submissions/urls

### Description
This endpoint is used to retrieve submission URLs. The example shows how to include the authentication token and required headers in the request.

### Method
GET

### Endpoint
https://onekyc.ky.id.sandbox.gopayapi.com/esign-partner/v1/submissions/urls

### Headers
- **x-onekyc-token** (string) - Required - The authentication token obtained from the token generation process.
- **x-esign-onboarding-partner** (string) - Required - Partner identifier, e.g., CLIENT_X-BE-CERT_REG.
- **x-partner-user-id** (string) - Required - Partner user identifier, e.g., user-12345.
- **x-partner-user-id-type** (string) - Required - Type of partner user ID, e.g., CLIENT_X_USER_ID.
- **x-partner-session-id** (string) - Required - Partner session identifier, e.g., session-abc-001.

### Request Example
```bash
curl -X GET "https://onekyc.ky.id.sandbox.gopayapi.com/esign-partner/v1/submissions/urls" \
  -H "x-onekyc-token: eyJraWQiOiJlY8sLk182F3J4..." \
  -H "x-esign-onboarding-partner: CLIENT_X-BE-CERT_REG" \
  -H "x-partner-user-id: user-12345" \
  -H "x-partner-user-id-type: CLIENT_X_USER_ID" \
  -H "x-partner-session-id: session-abc-001"
```

### Response
No response details are provided in the source documentation.
```

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

### Initialize GoPay Enterprise SDK

Source: https://docs.midtrans.com/docs/initialization

Example showing how to configure and initialize the SDK. Ensure enableDebugLogs is set to false in production.

```Kotlin
val configuration = GoPayEnterpriseConfiguration(
    clientID = "YOUR_CLIENT_ID",
    environment = GoPayEnterpriseEnvironment.STAGING,
    enableDebugLogs = true,
    locale = GoPayEnterpriseLocale.en,
)

val sdk = GoPayEnterpriseFactory.createEnterpriseSdk(
    context = applicationContext,
    configuration = configuration,
    callbackDelegate = object : GoPayEnterpriseCallbackDelegate {
        override fun onDismiss() {
            // Handle SDK dismissal
        }
        override fun onFailure(error: GoPayEnterpriseError) {
            // Handle initialization or runtime failure
        }
    }
)
```

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

### Offline Installment cURL Request

Source: https://docs.midtrans.com/docs/coreapi-advanced-features

Example cURL command to initiate an offline installment payment via the Midtrans Charge API.

```bash
curl -X POST \
  https://api.sandbox.midtrans.com/v2/charge \
  -H 'Accept: application/json'\
  -H 'Authorization: Basic <YOUR SERVER KEY ENCODED in Base64>' \
  -H 'Content-Type: application/json' \
  -d '{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "CustOrder-102",
    "gross_amount": 120000
  },
  "credit_card": {
    "token_id": "<token_id from Get Card Token Step>",
    "authentication": true,
    "installment_term": 12,
    "bins": ["48111111", "3111", "5"],
    "bank": "mandiri"
  }
}'
```

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

### Online Installment cURL Request

Source: https://docs.midtrans.com/docs/coreapi-advanced-features

Example cURL command to initiate an online installment payment via the Midtrans Charge API.

```bash
curl -X POST \
  https://api.sandbox.midtrans.com/v2/charge \
  -H 'Accept: application/json'\
  -H 'Authorization: Basic <YOUR SERVER KEY ENCODED in Base64>' \
  -H 'Content-Type: application/json' \
  -d '{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "CustOrder-102",
    "gross_amount": 120000
  },
  "credit_card": {
    "token_id": "<token_id from Get Card Token Step>",
    "authentication": true,
    "bank": "bni",
    "installment_term": 3
  }
}'
```

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

### Online Installment JSON Request Body

Source: https://docs.midtrans.com/docs/coreapi-advanced-features

Example JSON request body for an online installment transaction, requiring the installment_term and bank parameters.

```json
{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "CustOrder-102",
    "gross_amount": 120000
  },
  "credit_card": {
    "token_id": "<token_id from Get Card Token Step>",
    "authentication": true,
    "bank": "bni",
    "installment_term": 3
  }
}
```

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

### Initialize GoPayEnterprise SDK (After)

Source: https://docs.midtrans.com/docs/migration-guide

The updated initialization method using GoPayEnterpriseFactory and accessing KycManager.

```Kotlin
val configuration = GoPayEnterpriseConfiguration(
	clientID = <client_id_string>,
  environment = GoPayEnterpriseEnvironment.PRODUCTION, // or .GoPayEnterpriseEnvironment.STAGING
  enableDebugLogs = true,	// or false
  additionalData = emptymap(),
  locale = GoPayEnterpriseLocale.en	// or GoPayEnterpriseLocale.id
)

val sdk = GoPayEnterpriseFactory.createEnterpriseSdk(
	context = applicationContext,
  configuration = configuration,
  callbackDelegate = <GoPayEnterpriseCallbackDelegate>
)

// Obtain KycManager from the initialized SDK instance
val kycManager = sdk.getKycManager()
```

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

### Offline Installment JSON Request Body

Source: https://docs.midtrans.com/docs/coreapi-advanced-features

Example JSON request body for an offline installment transaction, utilizing the installment_term, bins, and bank parameters.

```json
{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "CustOrder-102",
    "gross_amount": 120000
  },
  "credit_card": {
    "token_id": "<token_id from Get Card Token Step>",
    "authentication": true,
    "installment_term": 12,          
    "bins": ["48111111", "3111", "5"],
    "bank": "mandiri"
  }
}
```

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

### KYC SDK Swift Implementation

Source: https://docs.midtrans.com/docs/kyc-sdk

Demonstrates the initialization of KycManager and the execution of KTP scanning, selfie liveness, and full KYC verification flows using their respective configuration objects.

```swift
// 1. Obtain KycManager from the initialized SDK instance
let kycManager = sdk.getKycManager()

// 2. Build a config
let config = EnterpriseKTPScanConfig(
    baseUrl: "https://kyc.example.com",
    token: "user-jwt-token",
    correlationId: "user-correlation-id",
    language: .id
)

// 3. Launch KTP Scan — result is delivered via completion closure
kycManager.launchKTPScan(config: config, from: self) { result in
    switch result.status {
    case .completed:
        print("KTP scan complete. Submission ID: \(result.submissionId ?? "")")
    case .notCompleted:
        print("KTP scan not completed: \(result.extra?.errorCode?.rawValue ?? "unknown")")
    case .error:
        print("KTP scan error: \(result.extra?.errorMessage ?? "unknown")")
    }
}

// 4. Selfie liveness
let selfieConfig = EnterpriseSelfieConfig(
    baseUrl: "https://kyc.example.com",
    token: "user-jwt-token",
    correlationId: "user-correlation-id",
    language: .id
)

kycManager.launchSelfieLiveness(config: selfieConfig, from: self, helpCenter: self) { result in
    print("Selfie liveness status: \(result.status.rawValue)")
}

// 5. KYC verification (full flow)
let kycConfig = EnterpriseKYCVerificationConfig(
    baseUrl: "https://kyc.example.com",
    token: "user-jwt-token",
    correlationId: "user-correlation-id",
    language: .id
)

kycManager.launchKYCVerification(config: kycConfig, from: self, helpCenter: self) { result in
    switch result.status {
    case .completed:
        print("KYC complete. Submission ID: \(result.submissionId ?? "")")
    case .notCompleted, .error:
        let code = result.extra?.errorCode?.rawValue ?? "none"
        let message = result.extra?.errorMessage ?? ""
        print("KYC did not complete [\(code)]: \(message)")
    }
}
```

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

### Get Card Token Failure Response

Source: https://docs.midtrans.com/docs/coreapi-card-payment-integration

Example of a failure response when parameters in the payload are invalid.

```JSON
{
  "status_code": "400",
  "status_message": "One or more parameters in the payload is invalid.",
  "validation_messages": [
    "This card is not supported for online transactions. Please contact your bank",
    "card_number does not match with Luhn algorithm"
  ],
  "id": "02197189-7cab-4006-8379-51edcd0a253b"
}
```

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

### Go Snap Transaction Request

Source: https://docs.midtrans.com/docs/snap-snap-integration-guide

Example of initiating the Snap client and executing a transaction request in Go.

```go
// 1. Initiate Snap client
var s = snap.Client
s.New("YOUR-SERVER-KEY", midtrans.Sandbox)
// Use to midtrans.Production if you want Production Environment (accept real transaction).

// 2. Initiate Snap request param
req := & snap.RequestParam{
    TransactionDetails: midtrans.TransactionDetails{
      OrderID:  "YOUR-ORDER-ID-12345",
      GrossAmt: 100000,
    }, 
    CreditCard: &snap.CreditCardDetails{
      Secure: true,
    },
    CustomerDetail: &midtrans.CustomerDetails{
      FName: "John",
      LName: "Doe",
      Email: "john@doe.com",
      Phone: "081234567890",
    },
  }

// 3. Execute request create Snap transaction to Midtrans Snap API
snapResp, _ := s.CreateTransaction(req)
```

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

### Add minimum_amount to credit_card installment terms

Source: https://docs.midtrans.com/docs/snap-advanced-feature

Include the 'minimum_amount' parameter under the 'credit_card' object to specify the minimum basket amount for each online installment bank and for offline installments. If the checkout amount is lower than the specified minimum, Snap will not show installment options. The example sets minimum amounts for BNI (100000) and offline (50000).

```json
{
  "transaction_details": {
    "order_id": "ORDER-101",
    "gross_amount": 10000
  },
  "credit_card": {
    "installment": {
      "required": false,
      "terms": {
        "bni": [3, 6, 12],
      },
      "minimum_amount": {
        "bni": 100000,
			  "offline" : 50000
      }
    }
  }
}
```

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

### Verify Flow Example Usage

Source: https://docs.midtrans.com/docs/features

Demonstrates how to build a FeatureRequest, define a CredentialReceiver, and execute the verify flow using the SDK's feature manager.

```kotlin
val request = FeatureRequest.Builder()
    .requestId("REQ-${System.currentTimeMillis()}")
    .userCorrelationId("user-correlation-id")
    .token("short-term-linking-token")
    .additionalData(mapOf("phone_number" to "+628123456789"))
    .build()

val credentialReceiver = CredentialReceiver.Exchange { credential, requestId ->
    if (credential is GoPayCredential.AuthCode) {
        val correlationId = myBackend.exchangeAuthCode(credential.code, requestId)
        ExchangeResult.Success(userCorrelationId = correlationId)
    } else {
        ExchangeResult.Failure(reason = "Unexpected credential type")
    }
}

sdk.getFeatureManager().verify(
    activity = this,
    request = request,
    credentialReceiver = credentialReceiver,
    callback = object : FeatureCallback<VerifyResult> {
        override fun onComplete(result: VerifyResult, data: Map<String, Any?>) {
            Log.d(TAG, "Submission ID: ${result.submissionId}")
        }
        override fun onError(error: GoPayEnterpriseError) {
            Log.e(TAG, "Error ${error.code}: ${error.message}")
        }
    }
)
```

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

### Sample Charge API Request with Online Installment

Source: https://docs.midtrans.com/docs/snap-advanced-feature

Example JSON parameters for a Snap charge API request with online installment. The 'terms' object lists banks (bca, bni, mandiri, cimb, bri) with installment term arrays. This is used in the backend API request step.

```json
{
  "transaction_details": {
    "order_id": "CustOrder-102",
    "gross_amount": 120000
  },
  "credit_card": {
    "secure": true,
    "installment": {
      "required": true,
      "terms": {
        "bca": [3,6,12],
        "bni": [3,6,12],
        "mandiri": [3,6,12],
        "cimb": [3,6,12],
        "bri": [3,6,12]
      }
    }
  }
}
```

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

### Initialize DigitalIdentity SDK (Before)

Source: https://docs.midtrans.com/docs/migration-guide

The legacy initialization method using DigitalIdentityProvider and a custom event tracker.

```Kotlin
private val myClientConfig: DigitalIdentityClientConfig = DigitalIdentityClientConfig(
	userId = <user_id_string>,
	userName = <optional_user_name_string>,
	environment = ClientEnvironment.PRODUCTION // or ClientEnvironment.STAGING
)

private val myEventTracker: IDigitalIdentityEventTracker = object: IDigitalIdentityEventTracker {
	override fun track(
		eventName: String,
    eventProperties: Map<String, Any?>,
    productName: String?
	) {
			// Callback is triggered by SDK with event and data to be tracked if required
	}
}

val sdkInstance: DigitalIdentitySdk = DigitalIdentityProvider.getInstance(
	appContext = applicationContext,
  clientConfig = myClientConfig,
  eventTracker = myEventTracker
)
```

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

### Sample Charge API Request for offline_bins

Source: https://docs.midtrans.com/docs/snap-advanced-feature

Example request body for a transaction using offline installment BINs.

```json
{
  "transaction_details": {
    "order_id": "CustOrder-102",
    "gross_amount": 120000
  },
  "credit_card": {
    "secure": true,
    "installment": {
      "required": true,
      "terms": {
        "offline": [3,6,12]
      }
    },
   	  "offline_bins": [
      "481111",
      "410505"
    ],
    "bank": "mandiri"
  }
}
```

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

### Basic Snap Pop Up Implementation

Source: https://docs.midtrans.com/docs/snap-snap-integration-guide

A basic example of triggering the Snap payment modal using window.snap.pay with a transaction token.

```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>

    <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
        window.snap.pay('TRANSACTION_TOKEN_HERE');
        // customer will be redirected after completing payment pop-up
      });
    </script>
  </body>
</html>
```

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

### Get Card Token Success Response

Source: https://docs.midtrans.com/docs/coreapi-card-payment-integration

Example of a successful response containing the token_id, which is valid for one transaction only.

```JSON
{
  "status_code": "200",
  "status_message": "Credit card token is created as Token ID.",
  "token_id": "48111111-1114-77328ff4-eba6-4201-b31a-1070d8f19ae9",
  "hash": "48111111-1114-xxxx"
}
```
Tokens:
Raw