Introduction

Welcome to Midtrans API!

Midtrans API is a RESTful Web Service served as a communication bridge between merchants and our payment channels.

HTTP(S) Request

Midtrans API can be requested through HTTP(S) Request to Midtrans Base URL endpoint. The HTTP(S) Header has to be used to allow proper authentication.

API Base URL

Development Environment : https://api.sandbox.midtrans.com
Production Environment : https://api.midtrans.com

HTTP(S) Header

Header	Value	Definition
Content-Type	application/json	The Content-Type field indicates that JSON type is acceptable to send to the recipient
Accept	application/json	The Accept field is used to specify that JSON type is acceptable for the response
Authorization	Basic base64(server key , :)	The Authorization field credentials can be found in Midtrans Merchant Admin Portal

Content-Type and Accept Header

In Midtrans API, the input and output parameters of the methods will be in JSON format. To accept JSON input and output parameters, you need to add the following HTTP(S) header:

• Content-Type: application/json
• Accept: application/json

Authorization Header

The authorization header utilizes Midtrans Server Key following HTTP(S) BASIC AUTH convention:

• For Development environment, obtain server key in Sandbox MAP Settings - Access Keys.
• For Production environment, obtain server key in MAP Settings - Access Keys.

Below is the step by step guideline:

1. Place Server Key as Username, following the format of BASIC AUTH.
   Username:Password
2. Since there is no Password for the server key, leave the password field blank.
3. If the server key is: 94960ece-9513-4265-9cf2-67a4da330213.
   Following BASIC AUTH Username and password format will become:
   94960ece-9513-4265-9cf2-67a4da330213:
   Note: Make sure there is ":" character after the server key!
4. Encode this value into base64 format, hence the result is:
   OTQ5NjBlY2UtOTUxMy00MjY1LTljZjItNjdhNGRhMzMwMjEzOg==
5. To be authorized to use Midtrans API, you need to add the following HTTP(S) header:
   Authorization: Basic OTQ5NjBlY2UtOTUxMy00MjY1LTljZjItNjdhNGRhMzMwMjEzOg==

Payment API

API Methods

Endpoint	HTTP Method	Definition
/v2/token	GET	Tokenize Credit Card information before being charged
/v2/charge	POST	Perform a transaction with various available payment methods and features. Example given: Credit Card Charge.
/v2/capture	POST	Capture an authorized transaction for card payment
/v2/order_id/approve	POST	Approve a transaction with certain order_id which gets challenge status from Fraud Detection System
/v2/order_id/deny	POST	Deny a transaction with certain order_id which gets challenge status from Fraud Detection System
/v2/order_id/cancel	POST	Cancel a transaction with certain order_id. Cancelation can only be done before settlement process
/v2/order_id/expire	POST	Update order_id with pending status to be expired
/v2/order_id/refund	POST	Update order_id with settlement status to be refund
/v2/order_id/refund/online/direct	POST	Attempt to send refund to bank or payment provider and update the transaction status to refund if it succeeded
/v2/order_id/status	GET	Get information status of a transaction with certain order_id
/v2/order_id/status/b2b	GET	Get information status of multiple B2B transactions related to certain order_id
/v2/card/register	GET	Register card information (card number and expiry) to be used for two clicks and one click
/v2/point_inquiry/token_id	GET	Get the point balance of the card in denomination amount
/v1/bins/bin_number	GET	Get Bin Metadata

Get Token

Token ID is a unique value that is associated with the customer’s credit card information during a transaction. Get Token method sends the credit card info via Midtrans.min.js to Midtrans server and returns the token ID to the merchant being charged.

Import Midtrans Javascript Library

<script id= "midtrans-script" src="https://api.midtrans.com/v2/assets/js/midtrans-new-3ds.min.js" data-environment="<production|sandbox>" data-client-key="<INSERT CLIENT KEY HERE>" type="text/javascript"></script>

Midtrans Javascript Library

To utilize this library, please add the following line of code at your payment page inside the <head> tag.

Midtrans Javascript library has two functions:

1. Get Card Token: To allows the customer’s credit card to be securely sent to Midtrans server, without the merchant handling the credit card details.
2. Redirect: To allow customer to be redirected into 3DS authentication page.

Attribute	Description
data-environment	To identify which environment the request is pointing to. Possible values: production, sandbox
data-client-key	Merchant client key settings

Get Card Token function

// Create the card object with the required fields
var card = {
    card_number: "4811111111111114",
    card_cvv: "123",
    card_exp_month: "12",
    card_exp_year: "2019"
}

var options = {
    onSuccess: function(response) {
        // Implement success handling here
    },
    onFailure: function(response) {
        // Implement error handling here
    }
}

MidtransNew3ds.getCardToken(card, options);

Getting Card Token

Card object attributes are listed below:

Field	Required	Description	Example
card_number	C	The 16 digits Credit Card number	"4111 1111 1111 1111" or "4111111111111111"
card_cvv	Y	The numeric digit printed on the back of the card	"123"
card_exp_month	C	The card expiry month	"03"
card_exp_year	C	The card expiry year	"2016"
token_id	C	The previously saved token of credit card. Get the value from saved_token_id from initial charge response	"481111-1114-0e68a4c4-85d3-48b5-b6cb-9945b2d3dcc9"

Most of the parameters are required conditionally based on the type of token being requested.

Token Type	Required Parameters
Normal	card_number, card_exp_month, card_exp_year, card_cvv
Two Clicks	token_id, card_cvv

Callback response object attributes are listed below:

Field	Description	Example
status code	The code of the response	"200" for success, "400" when validation error
status_message	The message of the status code	"OK, success request new token"
validation_messages	The validation errors	[“card_exp_year must be greater than this year”, "card_expire_month must be greater than this year's month”]
token_id	The token id of a credit card	"481111-1114-d3d690db-3e18-4edd-9fee-4d061e4eb6f3" NOTE: token_id is essential during Card Payment [Charge Transaction]

Available options:

Name	Description
onSuccess	This function is called only when get token responds with status code 200
onFailure	This function is called for every other status code but 200

Redirect function

var options = {
    // In case, Merchant needs to override for each transactions
    callbackUrl = "<ANY LINK>"
}

MidtransNew3ds.redirect(redirect_url, options);

How Midtrans redirect customer via html form (POST Method)

<form id="veritrans" method="post" action="<callbackUrl>">
    <input type="hidden" name="response" value="<JSON FORMAT CALLBACK OBJECT>"/>
</form>

Redirecting to 3DS Page

After proceeding card transaction to /charge API request, if the transaction need 3DS authentication, Merchant will receive redirect_url as part of the response. Merchant can optionally use built-in MidtransNew3ds.redirect function to redirect customer.

After 3DS process completed by customer, Customer will be redirected back to merchant website, either to specified callbackUrl or finish url configured on Merchant Dashboard. This final redirect is HTTP POST method, contains JSON string encapsulated as value of response key of the POST form-data.

Callback response object attributes are listed below:

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result
approval_code	String	Approval code. It can be used for refund. This does not exist on denied transaction
eci	String	The 3D secure ECI Code
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider
currency	String	ISO-4217 representation for 3 digit alphabetic currency code
card_type	String	Type of card used. Possible values: credit, debit

Available options:

Name	Description
callbackUrl	Optional. To override where the customer gets redirected after 3D secure authentication is done.

Sample code to open redirect_url on iframe (JQuery - Fancybox)

// Open 3DSecure dialog box
function openDialog(url) {
    // make sure to load fancybox in a script tag
    $.fancybox.open({
        href: url,
        type: 'iframe',
        autoSize: false,
        width: 400,
        height: 420,
        closeBtn: false,
        modal: true
    });
}

// Close 3DSecure dialog box
function closeDialog() {
    $.fancybox.close()
}

var options = {
  performAuthentication: function(url) {
    openDialog(url)
  },
  onSuccess: function(response) {
    // Successful handling
    closeDialog()
  },
  onPending: function(response) {
    // Pending handling
    closeDialog()
  },
  onFailure: function(response) {
    // Failure handling
    closeDialog()
  }
}

MidtransNew3ds.authenticate(redirect_url,options)

Opening 3DS Page via IFrame

As an alternative to the redirection scheme, Merchant can also optionally use MidtransNew3ds.performAuthentication function to open redirect_url as iframe.

After 3DS process completed by customer, Merchant website will receive JSONP callback containing the transaction result.

Callback response object attributes are listed below:

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result
approval_code	String	Approval code. It can be used for refund. This does not exist on denied transaction
eci	String	The 3D secure ECI Code
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider
currency	String	ISO-4217 representation for 3 digit alphabetic currency code
card_type	String	Type of card used. Possible values: credit, debit

Available options:

Name	Description
performAuthentication	Implementation on how to open redirect url in iframe.
onSuccess	Handle to receive successful callback response.
onPending	Handle to receive callback response. Only applicable when merchant applied for async endpoint.
onFailure	Handle to receive failure response

Charge features

Midtrans provides additional features that can be utilized by the merchants.

Set Custom Field

Set custom field charge request

{
  "payment_type": "bank_transfer",
  "bank_transfer": {
    "bank": "permata"
  },
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "custom_field1": "custom field 1 content",
  "custom_field2": "custom field 2 content",
  "custom_field3": "custom field 3 content"
}

Set custom field charge response

{
    "status_code": "200",
    "status_message": "Success, Credit Card transaction is successful",
    "transaction_id": "1eae238a-cb9e-4f92-b284-aac8b39e4eab",
    "order_id": "C17550",
    "gross_amount": "145000.00",
    "payment_type": "credit_card",
    "transaction_time": "2016-06-28 09:42:20",
    "transaction_status": "capture",
    "fraud_status": "accept",
    "approval_code": "256084",
    "masked_card": "481111-1114",
    "bank": "bni"
}

Set custom field Notifications

{
  "masked_card": "481111-1114",
  "approval_code": "256084",
  "bank": "bni",
  "transaction_time": "2016-06-28 09:42:20",
  "custom_field1": "Toko Rani",
  "custom_field2": "Jakarta",
  "custom_field3": "RR",
  "gross_amount": "10000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "ad7ccda03d8ec6f2f415661fb511d47fcd17dcc7d7e1ade96a305dd5d3bc2bea5438a8bdfe1aeedabdefb226000338ac169fc18d5ae73788fd5e78dbac945ce4",
  "status_code": "200",
  "transaction_id": "1eae238a-cb9e-4f92-b284-aac8b39e4eab",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

Set Custom Fields is a feature that enables merchants to charge a transaction with a unique data according to the merchant's need. Midtrans provides merchants with 3 custom fields that can be used for various utilities. Convention of a custom field can be set from Midtrans Merchant Admin Portal, as follow below:

1. Go to Configuration tab, under General Settings, set the custom fields label.
2. Request Charge transaction with the custom fields value.
3. These custom fields label and value can be checked at the Order ID of a transaction.
4. Midtrans will include these custom fields when the HTTP POST Notification is sent.

JSON Attribute	Type	Description
custom_field1	String(255)	The value of custom field 1
custom_field2	String(255)	The value of custom field 2
custom_field3	String(255)	The value of custom field 3

Set Custom Expiry

{
  "payment_type": "bank_transfer",
  "bank_transfer": {
    "bank": "permata"
  },
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "custom_expiry": {
      "order_time": "2016-12-07 11:54:12 +0700",
      "expiry_duration": 60,
      "unit": "minute"
  }
}

Set Custom Expiry feature enables merchants to set an expiry time of payment with pending status for every transaction. The following payment is the list of payment with Pending Status:

• Bank Transfer: Permata Virtual Account, BCA Virtual Account, Mandiri Bill Payment, BNI Virtual Account
• Direct Debit: BCA KlikPay, KlikBCA, e-pay BRI, CIMB Clicks, Danamon Online Banking
• e-Wallet: LINE Pay e-cash|mandiri e-cash, GO-PAY
• Over the Counter: Indomaret, Kioson
• Customer Financing: Akulaku

JSON Attribute	Type	Description
order_time	String(50)	Time when the order is created in merchant website. Format: yyyy-MM-dd hh:mm:ss Z. NOTE: If attribute undefined, expiry time starts from transaction time Symbol Meaning yyyy 4-digits year MM 2-digits month in year dd 2-digits day in month hh 2-digits hour (1-24) mm 2-digits minutes fraction ss 2-digits seconds fraction Z RFC-822 Timezone format
expiry_duration	String(50)	Time duration the payment will remain valid
unit	String(50)	Unit for expiry_duration. Valid values are: second, minute, hour, or day. NOTE: If attribute undefined, default unit is minute

Set Metadata

Set metadata charge request

{
  "payment_type": "bank_transfer",
  "bank_transfer": {
    "bank": "permata"
  },
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "metadata": {
    "you": "can",
    "put": "any",
    "parameter": "you like"
  }
}

Set Metadata Charge Response

{
    "status_code": "200",
    "status_message": "Success, Credit Card transaction is successful",
    "transaction_id": "1eae238a-cb9e-4f92-b284-aac8b39e4eab",
    "order_id": "C17550",
    "gross_amount": "145000.00",
    "payment_type": "credit_card",
    "transaction_time": "2016-06-28 09:42:20",
    "transaction_status": "capture",
    "fraud_status": "accept",
    "approval_code": "256084",
    "masked_card": "481111-1114",
    "bank": "bni"
}

Set Metadata Notifications

{
  "masked_card": "481111-1114",
  "approval_code": "256084",
  "bank": "bni",
  "transaction_time": "2016-06-28 09:42:20",
  "gross_amount": "10000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "ad7ccda03d8ec6f2f415661fb511d47fcd17dcc7d7e1ade96a305dd5d3bc2bea5438a8bdfe1aeedabdefb226000338ac169fc18d5ae73788fd5e78dbac945ce4",
  "status_code": "200",
  "transaction_id": "1eae238a-cb9e-4f92-b284-aac8b39e4eab",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "metadata": {
    "you": "can",
    "put": "any",
    "parameter": "you like"
  }
}

Set Metadata is similar with set custom field which enables merchant to put free-form JSON object instead of String. Merchants can use this metadata as a transaction tag where merchants retrieve it via Get Status or Notification payload. Additionally, merchants can also configure their fraud detection rules based on their metadata fields.

JSON Attribute	Type	Description
metadata	JSON Object	Object containing the metadata parameters

Capture Transaction

This method is used to capture transaction balance when transaction_status is authorize. Transaction with status authorize is only available after Pre Authorization Credit Card transaction.

Capture Transaction Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/capture	POST	Capture an authorized transaction for card payment

Capture Transaction Request

{
  "transaction_id": "be4f3e44-d6ee-4355-8c64-c1d1dc7f4590",
  "gross_amount": 145000
}

JSON Attribute	Type	Required	Description
transaction_id	String(255)	Y	Transaction id from charge response
gross_amount	Long	N	Amount to be captured. By default will capture whole transaction amount NOTE: Cannot be decimal

Capture Transaction Response

Success Capture Transaction Response

{
  "status_code" : "200",
  "status_message" : "Success, Credit Card capture transaction is successful",
  "transaction_id" : "ca297170-be4c-45ed-9dc9-be5ba99d30ee",
  "masked_card" : "451111-1117",
  "order_id" : "testing-0.4555-1414741517",
  "payment_type" : "credit_card",
  "transaction_time" : "2014-10-31 14:46:44",
  "transaction_status" : "capture",
  "fraud_status" : "accept",
  "bank" : "bni",
  "gross_amount" : "30000.00"
}

Error Capture Transaction Response

{
  "status_code" : "412",
  "status_message" : "Merchant cannot modify the status of the transaction"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after capture credit card transaction
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction capture result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction capture result

Approve Transaction

Approve method can be triggered to accept card payment transaction in which fraud_status is challenge.

Approve Transaction Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/{order_id OR transaction_id}/approve	POST	Approve Challenged Transaction

Approve Transaction Response

Success Approved Transaction Response

{
  "status_code" : "200",
  "status_message" : "Success, transaction is approved",
  "transaction_id" : "ca297170-be4c-45ed-9dc9-be5ba99d30ee",
  "masked_card" : "451111-1117",
  "order_id" : "testing-0.4555-1414741517",
  "payment_type" : "credit_card",
  "transaction_time" : "2014-10-31 14:46:44",
  "transaction_status" : "capture",
  "fraud_status" : "accept",
  "bank" : "bni",
  "gross_amount" : "30000.00"
}

Error Approve Transaction Response

{
  "status_code" : "412",
  "status_message" : "Merchant cannot modify the status of the transaction"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result

Deny Transaction

Deny method can be triggered to immediately deny card payment transaction in which fraud_status is challenge.

Deny Transaction Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/{order_id OR transaction_id}/deny	POST	Deny Challenged Transaction

Deny Transaction Response

Success Denied Transaction Response

{
  "status_code" : "200",
  "status_message" : "Success, transaction is denied",
  "transaction_id" : "ca297170-be4c-45ed-9dc9-be5ba99d30ee",
  "masked_card" : "451111-1117",
  "order_id" : "testing-0.4555-1414741517",
  "payment_type" : "credit_card",
  "transaction_time" : "2014-10-31 14:46:44",
  "transaction_status" : "deny",
  "fraud_status" : "deny",
  "bank" : "bni",
  "gross_amount" : "30000.00"
}

Error Deny Transaction Response

{
  "status_code" : "412",
  "status_message" : "Merchant cannot modify the status of the transaction"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result

Cancel Transaction

Card Payment

Card payment can be voided with cancel method if the transaction has not been settled. For Pre-Authorized transaction, Cancelling a Pre-Authorized transaction varies depending on the Acquiring Bank.

Acquiring Bank	Trigger Cancel Method
BNI	After pre-authorization payment has been captured
Mandiri	After pre-authorization payment initially being Charged
BCA, BRI, MAYBANK	Before and after pre-authorization payment has been captured

Pending Payment

Payment with Pending Status can be voided with cancel method if the transaction has not expired or has not been completed. The following payment is the list of payment with Pending Status:

• Bank Transfer: Permata Virtual Account, BCA Virtual Account, Mandiri Bill Payment, BNI Virtual Account
• Direct Debit: BCA KlikPay, KlikBCA, e-pay BRI, CIMB Clicks, Danamon Online Banking
• e-Wallet: LINE Pay e-cash|mandiri e-cash, GO-PAY
• Over the Counter: Indomaret, Kioson
• Customer Financing: Akulaku

Cancel Transaction Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/{order_id OR transaction_id}/cancel	POST	Cancel Transaction

Cancel Transaction Response and notification

Success Cancel Transaction Response

{
  "status_code" : "200",
  "status_message" : "Success, transaction is canceled",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "481111-1114",
  "order_id" : "example-1424936368",
  "payment_type" : "credit_card",
  "transaction_time" : "2015-02-26 14:39:33",
  "transaction_status" : "cancel",
  "fraud_status" : "accept",
  "bank" : "bni",
  "gross_amount" : "30000.00"
}

Error Cancel Transaction Response

{
  "status_code" : "412",
  "status_message" : "Merchant cannot modify the status of the transaction"
}

Success Cancel Transaction notification

{
  "masked_card": "420194-2900",
  "approval_code": "325511",
  "bank": "mandiri",
  "eci": "05",
  "transaction_time": "2016-07-04 13:32:44",
  "gross_amount": "244108.00",
  "order_id": "160288131764",
  "payment_type": "credit_card",
  "signature_key": "71f3b14d3036d2a60dac7fef1cdde7bebdbb2dbeebc68bcf5e7819fe8be7c9241611ea1e769e0c6775735805174c02b9d6b5cf89a11de1861d5efb298c9898b7",
  "status_code": "202",
  "transaction_id": "ffd82cd2-4f0d-4b24-b4b8-e201b0c3d80e",
  "transaction_status": "cancel",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. NOTE: Cancel transaction to deny / cancel it. Otherwise, transaction will automatically be settled during settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction cancel result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction cancel result

Expire transaction

Transaction status can be updated into expired if the customer has not complete the payment. The expired order id can be reused again with the same or different payment method.

Expire Transaction Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/{order_id OR transaction_id}/expire	POST	Expire Transaction

Expire Transaction Response

Success Expire Transaction Response

{
  "status_code": "407",
  "status_message": "Success, transaction has expired",
  "transaction_id": "447e846a-403e-47db-a5da-d7f3f06375d6",
  "order_id": "vtmbill05",
  "payment_type": "echannel",
  "transaction_time": "2015-06-15 13:36:24",
  "transaction_status": "expire",
  "gross_amount": "10000.00"
}

Error Expire Transaction Response

{
  "status_code" : "412",
  "status_message" : "Merchant cannot modify the status of the transaction"
}

Expired Transaction notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "841c7da8-530b-435a-9f67-c9d632d15537",
  "order_id": "1000176721005355",
  "gross_amount": "698879.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-07-04 00:53:55",
  "transaction_status": "expire",
  "permata_va_number": "8778004890127981",
  "signature_key": "f1066b06ec8a4b7d6ffb941fd9772f6df304618e15e02cf17c2914cec12793e19c71653042f7f617b027eae6ecb6759529c67eca9af55264b736408d8b4df2b9"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result

Refund transaction

Transaction status can be updated into refund if the customer decides to cancel completed/settlement payment. The same refund id cannot be reused again.

Refund Transaction Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/{order_id OR transaction_id}/refund	POST	Refund Transaction

Refund Transaction Request

{
  "refund_key": "reference1",
  "amount": 5000,
  "reason": "for some reason"
}

JSON Attribute	Type	Required	Description
refund_key	String	N	Merchant refund ID. If not passed then Midtrans will randomize one. It is recommended to use this param to avoid double refund attempt.
amount	Long	N	Amount to be refunded. By default will refund whole transaction amount
reason	String(255)	N	Reason justifying the refund

Refund Transaction Response

Success Full Refund Transaction Response

{
  "status_code": "200",
  "status_message": "Success, refund request is approved",
  "transaction_id": "447e846a-403e-47db-a5da-d7f3f06375d6",
  "order_id": "vtcc05",
  "payment_type": "credit_card",
  "transaction_time": "2015-06-15 13:36:24",
  "transaction_status": "refund",
  "gross_amount": "10000.00",
  "refund_chargeback_id": 1,
  "refund_amount": "10000.00",
  "refund_key": "reference1"
}

Success Partial Refund Transaction Response

{
  "status_code": "200",
  "status_message": "Success, refund request is approved",
  "transaction_id": "447e846a-403e-47db-a5da-d7f3f06375d6",
  "order_id": "vtcc05",
  "payment_type": "credit_card",
  "transaction_time": "2015-06-15 13:36:24",
  "transaction_status": "partial_refund",
  "gross_amount": "10000.00",
  "refund_chargeback_id": 1,
  "refund_amount": "5000.00",
  "refund_key": "reference1"
}

Error Invalid Refund Transaction Response

{
  "status_code" : "412",
  "status_message" : "Merchant cannot modify the status of the transaction"
}

Error Invalid Refund Transaction Response

{
  "status_code" : "414",
  "status_message" : "Refund request is rejected due to invalid amount"
}

Error Refund ID already Exists Transaction Response

{
  "status_code" : "406",
  "status_message" : "Duplicate refund ID"
}

Refund Transaction notification

{
  "status_code" : "200",
  "status_message" : "midtrans payment notification",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "481111-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",
  "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"
    },
    {
      "refund_chargeback_id": 2,
      "refund_amount": "7000.00",
      "created_at": "2015-02-28 01:23:15",
      "reason": "",
      "refund_key": "reference2",
      "refund_method": "offline"
    },
  ]
}

Refund Transaction notification (Bank Confirmed)

{
  "status_code" : "200",
  "status_message" : "midtrans payment notification",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "481111-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",
  "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"
    },
  ]
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after refund action, the possible values	are refund : Transaction is fully refunded. partial_refund: transaction is partially refunded
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
refund_chargeback_id	String	Identification of the refund process
refund_amount	String	Cumulative amount refunded
refund_key	String	Merchant refund reference

For notification JSON attributes, please follow the description on Get Status Response

Direct Refund Transaction

As opposed to previous refund API, this is used to directly send the refund request to bank or payment provider (third party). This API is useful to skip the standard operation process which may take 1 or 2 days after the initial refund request. The status of corresponding transaction will immediately be updated following the refund result received from third party. It will send HTTP notification only if the refund succeeded.

This API only supports payment type gopay and credit_card. Currently for credit_card, we only supports bank bca, maybank, bri, mandiri.

Direct Refund Transaction Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/{order_id OR transaction_id}/refund/online/direct	POST	Direct Refund Transaction

Direct Refund Transaction Request

{
  "refund_key": "reference1",
  "amount": 5000,
  "reason": "for some reason"
}

JSON Attribute	Type	Required	Description
refund_key	String	N	Merchant refund ID. If not passed then Midtrans will randomize one. It is recommended to use this param to avoid double refund attempt.
amount	Long	N	Amount to be refunded. By default will refund whole transaction amount
reason	String(255)	N	Reason justifying the refund

Direct Refund Transaction Response

Success Direct Refund Transaction Response

{
  "status_code": "200",
  "status_message": "Success, refund request is approved by the bank"
}

Rejected Direct Refund Transaction Response

{
  "status_code": "202",
  "status_message": "Refund denied by the bank"
}

Error Invalid Direct Refund Transaction Response

{
  "status_code" : "412",
  "status_message" : "Merchant cannot modify the status of the transaction"
}

Error Invalid Direct Refund Transaction Response

{
  "status_code" : "414",
  "status_message" : "Refund request is rejected due to invalid amount"
}

Error Refund ID already Exists Transaction Response

{
  "status_code" : "406",
  "status_message" : "Duplicate refund ID"
}

Direct Refund Full Amount Transaction notification

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "841c7da8-530b-435a-9f67-c9d632d15537",
  "order_id": "1000176721005355",
  "gross_amount": "698879.00",
  "payment_type": "credit_card",
  "transaction_time": "2016-07-04 00:53:55",
  "transaction_status": "refund",
  "permata_va_number": "8778004890127981",
  "signature_key": "f1066b06ec8a4b7d6ffb941fd9772f6df304618e15e02cf17c2914cec12793e19c71653042f7f617b027eae6ecb6759529c67eca9af55264b736408d8b4df2b9"
}

Direct Refund Partial Amount Transaction notification

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "841c7da8-530b-435a-9f67-c9d632d15537",
  "order_id": "1000176721005355",
  "gross_amount": "698879.00",
  "payment_type": "credit_card",
  "transaction_time": "2016-07-04 00:53:55",
  "transaction_status": "partial_refund",
  "permata_va_number": "8778004890127981",
  "signature_key": "f1066b06ec8a4b7d6ffb941fd9772f6df304618e15e02cf17c2914cec12793e19c71653042f7f617b027eae6ecb6759529c67eca9af55264b736408d8b4df2b9"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after refund action, the possible values	are refund : Transaction is fully refunded. partial_refund: transaction is partially refunded
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
refund_chargeback_id	String	Identification of the refund process
refund_amount	String	Cumulative amount refunded
refund_key	String	Merchant refund reference

Get Transaction Status

Transaction status can be obtained by triggering the Get Status Method.

Get Transaction Status Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/{order_id OR transaction_id}/status	GET	Get Status Transaction

Get Status Transaction Response

Success Get Status Transaction Response

{
  "status_code" : "200",
  "status_message" : "Success, transaction found",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "481111-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"
}

Success Get Status Refunded Transaction Response

{
  "status_code" : "200",
  "status_message" : "Success, transaction found",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "481111-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",
  "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"
    },
  ]
}

Success Get Status Refunded Transaction Response (Bank Confirmed)

{
  "status_code" : "200",
  "status_message" : "Success, transaction found",
  "transaction_id" : "249fc620-6017-4540-af7c-5a1c25788f46",
  "masked_card" : "481111-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",
  "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"
    },
  ]
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result
signature_key	String	Signature key to validate if the notification is originated from Midtrans
approval_code	String	Approval code from payment provider for successful transaction. It can be used for refund
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider
card_type	String	Type of card used. Possible values: credit, debit
refund_amount	String	Cumulative refund amount
refunds	Array	List of refund details related to the transaction. Only available on transaction status partial_refund or refund.

JSON Attribute	Type	Description
refund_chargeback_id	Integer	Midtrans refund ID
refund_amount	String	Amount of the specific refund
created_at	String	Timestamp of the refund creation
reason	String	Reason the refund is created
refund_key	String	Merchant refund reference
refund_method	String	Refund confirmation method. The value will be applied after Midtrans' operation confirm the refund request (1 day after request request is made). Possible values: online, offline
bank_confirmed_at	String	Timestamp of when refund request received confirmation from acquiring bank

Get Transaction Status B2B

Transaction status for all B2B transactions related to an order_id can be obtained by triggering the Get Status B2B Method.

Get Transaction Status B2B Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/{order_id OR transaction_id}/status/b2b	GET	Get Status B2B Transaction

Get Status Transaction B2B Parameter

Query Parameter	Required	Description
page	N	Index of the search. Default is 0.
per_page	N	Number of transactions which is presented. Default is 10.

Say merchant has 5 transactions created under a certain order_id A. The transactions are B, C, D, E, F (ordered to the latest). Below are the examples on how merchant can use page and per_page parameters.

1. per_page is not set, page is not set: Merchant gets F, E, D, C, B, A
2. per_page is set 2, page is not set: Merchant gets F, E
3. per_page is set 2, page is set 1: Merchant gets D, C
4. per_page is set 3, page is set 1: Merchant gets C, B, A

Get Status Transaction B2B Response

Success Get Status B2B Transaction Response

{
  "status_code": "200",
  "status_message": "Success, transactions are retrieved",
  "transactions": [
    {
      "payment_type": "echannel",
      "bill_key": "990568881594",
      "transaction_time": "2016-09-17 06:36:31",
      "gross_amount": "6000.00",
      "order_id": "vttesta73fb08ebd1-160916233631561",
      "signature_key": "ae85d0ade1bcdfdce4400b63918a8250b3ce45056621c743f71c02197e851accae43787190ee343b18f665d811a4e4d372bddbd347bda588a90d89c1b1c4ed53",
      "status_code": "200",
      "transaction_id": "647c9366-596a-4ba2-b20f-77baaa1e6647",
      "transaction_status": "settlement",
      "fraud_status": "accept",
      "status_message": "Success, transaction is found"
    },
    {
      "payment_type": "echannel",
      "bill_key": "990568881594",
      "transaction_time": "2016-09-17 06:34:52",
      "gross_amount": "6000.00",
      "order_id": "vttesta73fb08ebd1",
      "signature_key": "e8ae2f8cba40fe505c3c0f8bfec8dbc748ee5c8d04ad0699f33d17b7fc6aba5b1218f518226b4ea2ff095cb60125a5e6e1cb345608446378d29cb10ad687f560",
      "status_code": "200",
      "transaction_id": "f9a6684f-e3b4-46dd-8b6c-b61d805b3c6f",
      "transaction_status": "settlement",
      "fraud_status": "accept",
      "status_message": "Success, transaction is found"
    }
  ]
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result
signature_key	String	Signature key to validate if the notification is originated from Midtrans
approval_code	String	Approval code from payment provider for successful transaction. It can be used for refund
transactions	Array	Collections of transaction status objects

Register Card

Register Card Status Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/card/register	GET	Register card information (card number and expiry) to be used for two clicks and one click

Register Card Request

Put these parameters as query parameters on the URL.

JSON Attribute	Type	Required	Description
card_number	String	Y	Credit card number
card_exp_month	String	Y	Credit card expiry month
card_exp_year	String	Y	Credit card expiry year
client_key	String	Y	Partner client key credential
callback	String	N	Function name used for JSONP callback

Register Card Response

Success Register Card Response

{
  "status_code": "200",
  "saved_token_id": "436502PjvfpHomPBggDvfipaIYhV0009",
  "transaction_id": "50e7c4ac-772e-43fa-94fb-52559bce4fc0",
  "masked_card": "436502-0009"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
saved_token_id	String	Token id used for two clicks or one click

Point Inquiry

Point Inquiry Status Method

Endpoint	HTTP Method	Definition
BASE_URL/v2/point_inquiry/{token_id}	GET	Get the point balance of the card in denomination amount

Point Inquiry Request

Put these parameters as query parameters on the URL.

JSON Attribute	Type	Required	Description
gross_amount	String	C	The volume of the following transaction. This number can decide the remaining point balance amount which can be used on the response. NOTE: Needed for Mandiri Point

Point Inquiry Response

Success Point Inquiry Response

{
  "status_code": "200",
  "status_message": "Success, Credit Card Point inquiry is successful",
  "transaction_time": "2017-05-29 12:21:40",
  "point_balance_amount": "10000.00"
}

JSON Attribute	Type	Description
status_code	String	Status code of transaction result
status_message	String	Status message of transaction result
transaction_time	String	Time of the transactions
point_balance_amount	String	Denomination amount of the point balance

Bin API

Midtrans API provide Bin Lookup API to get metadata for a particular bin, such as card type (Debit/Credit) or the card brand (ex. Visa, Master)

Endpoint

Bin API Response Sample

{
    "data": {
        "country_name": "Indonesia",
        "country_code": "id",
        "brand": "visa",
        "bin_type": "credit",
        "bin_class": "gold",
        "bin": "455633",
        "bank_code": "bca",
        "bank": "bank central asia"
    }
}

Endpoint	HTTP Method	Definition
/v1/bins/bin_number	GET	Get Bin Metadata

Authorization Header

The request is authorized using the same method as HTTP(S) Request with an additional note that Midtrans Client Key can also be used other than Midtrans Server key

It is highly recommended to use client key if the request is made from browser/mobile.

Rate Limit

All bin request is rate-limited by 100 request per minute. If the attempted request is more than the limit, Midtrans API will respond with 409 status code.

Response Codes

Code	Description
200	OK
404	Particular Bin Is not exist
401	Credential is empty or wrong. Please recheck the auth configuration
409	Request exceed the rate limit

Response Object

Field	Description	Type	Nullable	Sample
bank	Bank Name of the Card	String	Yes	bank central asia
bank_code	bank code	String	Yes	bca
bin	bin number requested	String	No	455633
bin_type	Card Type	String (Debit / Credit)	No	credit
bin_class	Card Class	String	Yes	gold
brand	Card issuer Brand	String	Yes	visa
country_name	Country which issuing the Card	String	Yes	Indonesia
country_code	Code name of the respective country	String	Yes	id

Recurring API

Recurring API is intended for recurring transaction (transaction that will deduct customer's fund periodically).

Merchant can perform recurring transaction by creating subscription details. Midtrans will attempt to auto deduct customer funds based on details from merchant's subscription (subscription schedule, amount, etc). This way, merchant doesn't need to manually do recurring transaction.

API Methods

Endpoint	HTTP Method	Definition
/v1/subscriptions	POST	Create subscription that contains all details for creating transaction
/v1/subscriptions/subscription_id	GET	Find subscription by id to see the subscription details
/v1/subscriptions/subscription_id/disable	POST	Make the subscription inactive (the subscription will not create transaction anymore)
/v1/subscriptions/subscription_id/enable	POST	Make the subscription active (the subscription will create periodic transaction)
/v1/subscriptions/subscription_id	PATCH	Update existing subscription details

Create Subscription

Create subscription that contains all details for creating transaction.

Create Subscription Method

Endpoint	HTTP Method	Definition
BASE_URL/v1/subscriptions	POST	Create subscription

Create Subscription Request

{
    "name": "SUBSCRIBE1",
    "amount": "14000",
    "currency": "IDR",
    "payment_type": "credit_card",
    "token": "481111DasKBLCCXbuKfEbVlFiBZr1114",
    "schedule": {
      "interval": 1,
      "interval_unit": "month"
    }
}

JSON Attribute	Type	Required	Description
name	String(15)	Y	Subscription's name that will be use to generate transaction's order id. Note: Allowed symbols are dash(-), underscore(_), tilde (~), and dot (.)
amount	Long	Y	Amount that will be use to make recurring charge. Note: Do not use decimal
currency	String	Y	ISO-4217 representation for 3 digit alphabetic currency code. Note: Currently only support IDR
payment_type	String	Y	Transaction payment method. Note: currently only support credit_card
token	String	Y	Saved payment token. Note: For credit_card should use saved_token_id received in charge response
schedule	Object	Y	Subscription schedule details

Create Subscription Response

{
  "id": "d98a63b8-97e4-4059-825f-0f62340407e9",
  "name": "SUBSCRIBE1",
  "amount": "14000",
  "currency": "IDR",
  "created_at": "2019-05-29T09:11:01.810452",
  "schedule": {
    "interval": 1,
    "interval_unit": "month",
    "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": "481111DasKBLCCXbuKfEbVlFiBZr1114",
  "payment_type": "credit_card",
  "transaction_ids": []
}

JSON Attribute	Type	Description
id	String	Subscription ID given by Midtrans
name	String	Subscription name given by merchant
amount	String	Amount given by merchant for recurring charge
currency	String	Currency given by merchant for recurring charge
created_at	String	Timestamp of subscription
schedule	Object	Subscription schedule details
status	String	Current subscription Status. Note: Possible status value is active and inactive
token	String	Payment token used for subscription
payment_type	String	Transaction payment method given by merchant. Note: currently only support credit_card
transaction_ids	Array(String)	List of transaction IDs which is successfully charged

Get Subscription

Find subscription by id to see the subscription details

Get Subscription Method

Endpoint	HTTP Method	Definition
BASE_URL/v1/subscriptions/{subscription_id}	GET	Get subscription

Get Subscription Response

{
  "id": "d98a63b8-97e4-4059-825f-0f62340407e9",
  "name": "SUBSCRIBE1",
  "amount": "14000",
  "currency": "IDR",
  "created_at": "2019-05-29T09:11:01.810452",
  "schedule": {
    "interval": 1,
    "interval_unit": "month",
    "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": "481111DasKBLCCXbuKfEbVlFiBZr1114",
  "payment_type": "credit_card",
  "transaction_ids": []
}

JSON Attribute	Type	Description
id	String	Subscription ID given by Midtrans
name	String	Subscription name given by merchant
amount	String	Amount given by merchant for recurring charge
currency	String	Currency given by merchant for recurring charge
created_at	String	Timestamp of subscription
schedule	Object	Subscription schedule details
status	String	Current subscription Status. Note: Possible status value is active and inactive
token	String	Payment token used for subscription
payment_type	String	Transaction payment method given by merchant. Note: currently only support credit_card
transaction_ids	Array(String)	List of transaction IDs which is successfully charged

Disable Subscription

Make the subscription inactive (the subscription will not create transaction anymore)

Disable Subscription Method

Endpoint	HTTP Method	Definition
BASE_URL/v1/subscriptions/{subscription_id}/disable	POST	Disable subscription

Disable Subscription Response

{
  "status_message": "Subscription is updated."
}

JSON Attribute	Type	Description
status_message	String	API result description

Enable Subscription

Make the subscription active (the subscription will create periodic transaction)

Enable Subscription Method

Endpoint	HTTP Method	Definition
BASE_URL/v1/subscriptions/{subscription_id}/enable	POST	Enable subscription

Enable Subscription Response

{
  "status_message": "Subscription is updated."
}

JSON Attribute	Type	Description
status_message	String	API result description

Update Subscription

Update existing subscription details

Update Subscription Method

Endpoint	HTTP Method	Definition
BASE_URL/v1/subscriptions/{subscription_id}	PATCH	Update subscription

Update Subscription Request

{
    "name": "SUBSCRIBE1",
    "amount": "14000",
    "currency": "IDR",
    "payment_type": "credit_card",
    "token": "481111DasKBLCCXbuKfEbVlFiBZr1114",
    "schedule": {
      "interval": 1,
      "interval_unit": "month"
    }
}

JSON Attribute	Type	Required	Description
name	String(15)	Y	Subscription's name that will be use to generate transaction's order id. Note: Allowed symbols are dash(-), underscore(_), tilde (~), and dot (.)
amount	Long	Y	Amount that will be use to make recurring charge. Note: Do not use decimal
currency	String	Y	ISO-4217 representation for 3 digit alphabetic currency code. Note: Currently only support IDR
payment_type	String	Y	Transaction payment method. Note: currently only support credit_card
token	String	Y	Saved payment token. Note: For credit_card should use saved_token_id received in charge response
schedule	Object	Y	Subscription schedule details

Update Subscription Response

{
  "status_message": "Subscription is updated."
}

JSON Attribute	Type	Description
status_message	String	API result description

Credit Card

Integration steps:

1. Get token.
2. Perform charge transaction using the token.
3. (Optional) If transaction is 3D secure, do redirection to address specified in the response.
4. Handle notification.

Credit Card Charge

Complete credit card charge request

{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "credit_card": {
    "token_id": "< your token ID >"
  },
  "item_details": [{
      "id": "a1",
      "price": 145000,
      "quantity": 2,
      "name": "Apel",
      "brand": "Fuji Apple",
      "category": "Fruit",
      "merchant_name": "Fruit-store"
    }],
    "customer_details": {
      "first_name": "BUDI",
      "last_name": "UTOMO",
      "email": "test@midtrans.com",
      "phone": "+628123456",
      "billing_address": {
        "first_name": "BUDI",
        "last_name": "UTOMO",
        "email": "test@midtrans.com",
        "phone": "081 2233 44-55",
        "address": "Sudirman",
        "city": "Jakarta",
        "postal_code": "12190",
        "country_code": "IDN"
      },
      "shipping_address": {
        "first_name": "BUDI",
        "last_name": "UTOMO",
        "email": "test@midtrans.com",
        "phone": "0 8128-75 7-9338",
        "address": "Sudirman",
        "city": "Jakarta",
        "postal_code": "12190",
        "country_code": "IDN"
      }
    }
}

Charge method is triggered every time a transaction is performed. The attribute that is used is dependent on the payment method desired.

JSON Attribute	Type	Required	Description
payment_type	String (255)	Y	Set credit card payment method. Value is "credit_card"
transaction_details	Object	Y	Transaction details
credit_card	Object	Y	Charge details using credit card
item_details	Object	N	Shopping item details
customer_details	Object	N	Customer Details

Card Payment Charge Response and Notifications

Card Payment Charge Response

{
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "order_id": "C17550",
  "gross_amount": "145000.00",
  "payment_type": "credit_card",
  "transaction_time": "2014-08-24 15:39:22",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "masked_card": "481111-1114",
  "status_code": "200",
  "bank": "bni",
  "status_message": "Success, Credit Card 3D Secure transaction is successful",
  "approval_code": "1408869563148",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "currency": "IDR",
  "card_type": "credit"
}

Card Payment Charge Error Response

{
    "status_code": "411",
    "status_message": "Token id is missing, invalid, or timed out"
}

Card Payment Capture Notification

{
  "masked_card": "481111-1114",
  "approval_code": "T58755",
  "bank": "bni",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "8d22a6b625f395a1a2cf0e62497e20be433cbad3e8a8ff36bf6b40dbd47308125ccda93546eab8a3acd91390155082658ac25b10a6294c6660642e43a5edc8bb",
  "status_code": "200",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Card Payment Deny notification

{
  "masked_card": "481111-1114",
  "approval_code": "338016",
  "bank": "bni",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "763713b31cf59c886d3cc4a0c654a060a8e990080fe29fca75ae9e4ff9de804809c4e20977829844dac01a7ac1464a4eb095ad32482048398918987295dc5022",
  "status_code": "202",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "05",
  "channel_response_message": "Do not honor",
  "card_type": "credit"
}

Card Payment Challenge notification

{
  "masked_card": "481111-1114",
  "approval_code": "315762",
  "bank": "bni",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "393f8b6b27f9f6385d8391642942e9534fd20dad20c0631b75b0746bfc314482af4411c93e958b691a63e9154676905b906234d1f12fca031f5be5593f7ec2c6",
  "status_code": "201",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "capture",
  "fraud_status": "challenge",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Card Payment Settlement notification

{
  "masked_card": "481111-1114",
  "approval_code": "131755",
  "bank": "bni",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "49e158a0c3f1913eae0902875324075c562daa39b2824b865db2242adea247a228960d2f1002392fdbc29c3271c2bc78ba72e588db9047a82932d0615ddc811f",
  "status_code": "200",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Two of the most important information details in the JSON response is the transaction and fraud status, which can be found in transaction_status and fraud_status attribute.

1. Transaction status capture and fraud_status accept: Transaction successful.
2. Transaction status deny and fraud_status anything: Transaction rejected by bank or by Fraud Detection System (FDS).
3. Transaction status capture and fraud_status challenge: Transaction challenge. You have to make a confirmation at Merchant Administration Portal (MAP).

At this point, the payment process of a transaction is complete. If the transaction_status value is capture and fraud_status value is accept, the customer’s credit card has been charged to your account. In addition to sending the transaction status to the customer, you can also update the respective database. Example, to mark if the respective order_id has been paid.

Transaction status can also be found in Merchant Administration Portal (MAP). You have to login to MAP to see the detail of the transaction. The other alternative to check on the transaction status is to use the command Acquiring Transaction Status.

By default, all credit card transactions from 00.00 until 23.59, will be settled on the day after at 16.00. The transaction status will be updated from capture into settlement. If there is any unapproved challenged transaction, Midtrans will cancel the transaction automatically. Midtrans will also send HTTP POST notification to merchant endpoint.

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result
approval_code	String	Approval code. It can be used for refund. This does not exist on denied transaction
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider
card_type	String	Type of card used. Possible values: credit, debit

Card Features: 3D Secure

Card Payment 3D Secure charge

{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "credit_card": {
    "token_id": "< your token ID >",
    "authentication": true
  }
}

To configure the 3D Secure feature, an additional attribute will be required in credit_card object:

JSON Attribute	Type	Required	Description
token_id	String	Y	Token ID represents customer's credit card information acquired from Get Token Response
authentication	Boolean	N	Flag to enable the 3D secure authentication. Default value is false.
callback_type	String	N	Determine how the transaction status will be updated to the client side. Possible values: js_event (default) or form. More details will be explained here.

3D Secure Charge Response and Notifications

3D Secure Charge Response has additional redirect_url to forward merchant's user to the authentication page. Then, after the authentication process is complete, merchant will receive notification containing both the transaction and 3D Secure result.

Successful Charge Response

{
    "status_code": "201",
    "status_message": "Credit Card transaction is in progress",
    "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
    "order_id": "C17550",
    "redirect_url": "https://api.veritrans.co.id/v2/token/rba/redirect/451249-2595-e14aac7f-cfb3-4ab2-98ab-5cc5e70f4b2c",
    "gross_amount": "145000.00",
    "currency": "IDR",
    "payment_type": "credit_card",
    "transaction_time": "2018-09-12 22:10:23",
    "transaction_status": "pending",
    "masked_card": "481111-1114",
  "card_type": "credit"
}

Validation Error Response

{
    "status_code": "400",
    "status_message": "One or more parameters in the payload is invalid.",
    "id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
    "validation_messages": [
        "unsupported token request parameter(s)"
    ]
}

Capture Notification

{
  "masked_card": "481111-1114",
  "approval_code": "T58755",
  "bank": "bni",
  "eci": "05",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "8d22a6b625f395a1a2cf0e62497e20be433cbad3e8a8ff36bf6b40dbd47308125ccda93546eab8a3acd91390155082658ac25b10a6294c6660642e43a5edc8bb",
  "status_code": "200",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Deny Notification

{
  "masked_card": "481111-1114",
  "approval_code": "338016",
  "bank": "bni",
  "eci": "06",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "763713b31cf59c886d3cc4a0c654a060a8e990080fe29fca75ae9e4ff9de804809c4e20977829844dac01a7ac1464a4eb095ad32482048398918987295dc5022",
  "status_code": "202",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "05",
  "channel_response_message": "Do not honor",
  "card_type": "credit"
}

Challenge Notification

{
  "masked_card": "481111-1114",
  "approval_code": "315762",
  "bank": "bni",
  "eci": "05",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "393f8b6b27f9f6385d8391642942e9534fd20dad20c0631b75b0746bfc314482af4411c93e958b691a63e9154676905b906234d1f12fca031f5be5593f7ec2c6",
  "status_code": "201",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "capture",
  "fraud_status": "challenge",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Settlement Notification

{
  "masked_card": "481111-1114",
  "approval_code": "131755",
  "bank": "bni",
  "eci": "05",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "49e158a0c3f1913eae0902875324075c562daa39b2824b865db2242adea247a228960d2f1002392fdbc29c3271c2bc78ba72e588db9047a82932d0615ddc811f",
  "status_code": "200",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

In additional to the normal credit card attributes, these are the exclusive attributes for 3D Secure response and notifications:

JSON Attribute	Type	Description
redirect_url	String	Redirect user to 3D Secure authentication page.
eci	String	The 3D secure ECI Code.

Handling 3D Secure Callback

By default, 3D Secure callback scheme is set as js_event. It is optimized for merchant who prefers to open the 3D Secure page in the same page

Midtrans javascript library provide function to handle the redirect url and its callback response. Merchant may use the same callback implemented in the previous API.

Authenticate function from the Javascript Library to handle the redirect url and callback response

// Create the callback function according to Midtrans response
function callback(response) {
        // Handling of Midtrans Callback Response Object explained below
};

//Authenticate function
Veritrans.authenticate(redirect_url, callback);

The response object attributes are the same as the ones from charge response above.

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result
approval_code	String	Approval code. It can be used for refund. This does not exist on denied transaction
eci	String	The 3D secure ECI Code
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider
currency	String	ISO-4217 representation for 3 digit alphabetic currency code
card_type	String	Type of card used. Possible values: credit, debit

Sample callback function implementation

function callback(response) {
  if (response.redirect_url) {
    // initially Midtrans will put the redirect url into the response
    // it will be up to merchant on how to open it
    console.log('Open Dialog 3Dsecure');
    openDialog(response.redirect_url);

  } else if (response.status_code == '200') {
    // success transaction
    // close 3d secure dialog if any
    closeDialog();

    handleSuccessfulResponse(response);
  } else {
    // failed transaction
    // close 3d secure dialog if any
    closeDialog();

    handleFailedResponse(response);
  }
}

// Open 3DSecure dialog box
function openDialog(url) {
  // make sure to load fancybox in a script tag
  $.fancybox.open({
        href: url,
        type: 'iframe',
        autoSize: false,
        width: 400,
        height: 420,
        closeBtn: false,
        modal: true
    });
}

// Close 3DSecure dialog box
function closeDialog() {
  $.fancybox.close();
}

function handleSuccessfulResponse(response) {
  // dummy function
}

function handleFailedResponse(response) {
  // another dummy function
}

As for callback via form, it should be straightforward as it is only a simple redirection.

Card Features: BIN Promo

Card Payment BIN Promo Charge

{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "credit_card": {
    "token_id": "< your token ID >",
    "bank": "bni",
    "bins": ["48111111", "bni", "5"]
  }
}

To configure the BIN Promo feature, an additional attribute will be required in credit_card object:

JSON Attribute	Type	Description
token_id	String	Token ID represents customer's credit card information acquired from Get Token Response
bank	String	Acquiring bank
bins	JSON Array	List of credit card's BIN (Bank Identification Number) that is allowed for transaction. NOTE: 48111111 = Allow only card number beginning with 48111111 bni = Allow only card issued by BNI 5 = Allow only card beginning with 5 (Mastercard)

BIN Promo Charge Response and Notifications

BIN Promo Charge Response and Notifications are identical with Card Payment Charge Response. Successful BIN Promo transaction is described as capture and is ready for settlement.

Card Features: Installment

Card Payment Installment Charge

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

You need a Normal Token to charge with Installment feature. To charge the installment feature, additional attributes will be required in charge request credit_card object:

JSON Attribute	Type	Description
token_id	String	Token ID represents customer's credit card information acquired from Get Token Response
bank	String	Acquiring bank. To make sure transaction is going on-us. Else, it will be treated as offline installment.
installment_term	Array Integer	Installment Tenor

Installment Charge Response and Notifications

Card Payment Installment Charge Response

{
      "status_code": "200",
      "status_message": "Success, Credit Card transaction is successful",
      "transaction_id": "c1e1cc28-5208-4965-bc99-076919dc0a26",
      "order_id": "20527106",
      "gross_amount": "1687180.00",
      "payment_type": "credit_card",
      "transaction_time": "2016-06-19 09:12:15",
      "transaction_status": "capture",
      "fraud_status": "accept",
      "approval_code": "R71372",
      "masked_card": "542640-9747",
      "bank": "bni",
      "installment_term": "6",
      "channel_response_code": "00",
      "channel_response_message": "Approved",
      "currency": "IDR",
      "card_type": "credit"
}

Card Payment Online Installment Capture Notifications

{
  "masked_card": "542640-9747",
  "approval_code": "R71372",
  "bank": "bni",
  "eci": "01",
  "installment_term": 6,
  "transaction_time": "2016-06-19 09:12:15",
  "gross_amount": "1687180.00",
  "order_id": "20527106",
  "payment_type": "credit_card",
  "signature_key": "4a4e59bdc26b3c473014f8dbc1bb9faf35c1f29c473f48666ea6faaf9d8eb80bf8e47be8d79ef4cdec820c6aecad7da198a64461cdf08937f7c56688fafb8448",
  "status_code": "200",
  "transaction_id": "c1e1cc28-5208-4965-bc99-076919dc0a26",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Successful Installment transaction is described as capture and is ready for settlement.

Offline Installment

Card Payment Offline Installment Charge

{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "credit_card": {
    "token_id": "< your token ID >",
    "installment_term": 12,          
    "bins": ["48111111", "3111", "5"]
  }
}

Offline installment feature allow merchants to do installment conversion for transactions which are not supported by MID installment.

To charge the offline installment feature in Core API, additional attributes installment will be required with combination bins. The purpose of bins is to limit certain cards that can be used depending on the agreement between merchant and banks.

Below is the charge request for offline installment:

Offline Installment Charge Response and Notifications

Card Payment Offline Installment Charge Response

{
   "status_code": "200",
   "status_message": "Success, Credit Card transaction is successful",
   "transaction_id": "b046340b-dc40-480a-828f-085fc265850c",
   "order_id": "62465770",
   "gross_amount": "1352373.00",
   "payment_type": "credit_card",
   "transaction_time": "2016-06-19 05:41:18",
   "transaction_status": "capture",
   "fraud_status": "accept",
   "approval_code": "854442",
   "eci": "05",
   "masked_card": "414009-6871",
   "bank": "bni",
   "installment_term": "6",
   "channel_response_code": "00",
   "channel_response_message": "Approved",
   "currency": "IDR",
   "card_type": "credit"
}

Card Payment Offline Installment Notifications

{
  "masked_card": "414009-4550",
  "approval_code": "833736",
  "bank": "bni",
  "eci": "05",
  "installment_term": 12,
  "transaction_time": "2016-07-04 14:00:55",
  "gross_amount": "16277555.00",
  "order_id": "160288134251",
  "payment_type": "credit_card",
  "signature_key": "1742c43dbda320dfe26a0e570eb8c95f710058967a2bb45b3996b664e19feb30aec8a6458be56ee310e7941fb89e3e3da09833b0f858fc8226bfa0442af2b5b0",
  "status_code": "201",
  "transaction_id": "3c1b1f1a-bfcf-4fa1-9a93-bebf5b9cb488",
  "transaction_status": "capture",
  "fraud_status": "challenge",
  "status_message": "midtrans payment notification",
  "card_type": "credit"
}

Successful Installment transaction is described as capture and is ready for settlement.

Card Features: Pre-Authorization

Card Payment pre-Authorization Charge

{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "credit_card": {
    "token_id": "< your token ID >",
    "bank": "bni",
    "type": "authorize"   
  }
}

You need a Normal Token from Get Token to charge with Pre-Authorization feature. To configure the Pre-Authorization feature in Core API, an additional attribute will be required in charge request credit_card object.

JSON Attribute	Type	Description
token_id	String	Token ID represents customer's credit card information acquired from Get Token Response
type	String	Attribute to enable the pre-authorization feature. Valid value authorize

Pre-Authorization Charge Response and Notifications

Card Payment Pre-Authorization Charge Response

{
    "status_code": "200",
    "status_message": "Success, Credit Card transaction is successful",
    "transaction_id": "be4f3e44-d6ee-4355-8c64-c1d1dc7f4590",
    "order_id": "C17550",
    "gross_amount": "145000.00",
    "payment_type": "credit_card",
    "transaction_time": "2016-07-02 14:00:27",
    "transaction_status": "authorize",
    "fraud_status": "accept",
    "approval_code": "003873",
    "eci": "05",
    "masked_card": "481111-1114",
    "bank": "bca",
    "channel_response_code": "0",
    "channel_response_message": "Approved",
    "currency": "IDR",
    "card_type": "credit"
}

Card Payment Pre-Authorization notification

{
  "masked_card": "481111-1114",
  "approval_code": "003873",
  "bank": "bca",
  "eci": "05",
  "transaction_time": "2016-07-02 14:00:27",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "7156a83f0beb052c689e3775e60049062dd84379eda494b929704955957a41949df03c7010a0ad888347828f04b9288bdf541e044569372d1ab957295a6c5a14",
  "status_code": "200",
  "transaction_id": "be4f3e44-d6ee-4355-8c64-c1d1dc7f4590",
  "transaction_status": "authorize",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "0",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Pre-Authorization Charge Response is different with Card Payment Charge Response. Successful Pre-Authorization transaction is described as authorize and can be settled only if the transaction has been captured. If the transaction is captured, the transaction status will be updated into capture and ready for settlement.

To charge for pre-Authorization, capture transaction method is used in which transaction_status is set to authorize.

{
    "transaction_id" : "1ac1a089d-a587-40f1-a936-a7770667d6dd",
    "gross_amount" : 55000              // <--- Value should not exceed the Charge Value on Pre-Authorization
}

Capture Transaction Method

Endpoint	HTTP Method	Definition
BASE_URL/capture	POST	Capture a Pre-Authorized Transaction

Body Message:

JSON Attribute	Type	Description
transaction_id	String	Transaction ID from Charge Pre-Authorization Response
gross_amount	Long	The value of transactions which will be paid by the customer. Note: Should not exceed the value of Charge Pre-Authorization transaction. If left undefined, capture full transaction

Capture Transaction Response and notification

Capture Transaction Response

{
    "status_code": "200",
    "status_message": "Success, Credit Card capture transaction is successful",
    "transaction_id": "1ac1a089d-a587-40f1-a936-a7770667d6dd",
    "order_id": "A27550",
    "payment_type": "credit_card",
    "transaction_time": "2014-08-25 10:20:54",
    "transaction_status": "capture",
    "fraud_status": "accept",
    "masked_card": "481111-1114",
    "bank": "bca",
    "eci": "05",
    "gross_amount": "55000.00",
    "channel_response_code": "0",
    "channel_response_message": "Approved",
    "currency": "IDR",
    "card_type": "credit"
}

Capture Transaction notification

{
  "masked_card": "481111-1114",
  "approval_code": "T67700",
  "bank": "bca",
  "eci": "05",
  "transaction_time": "2014-08-25 10:20:54",
  "gross_amount": "55000.00",
  "order_id": "A27550",
  "payment_type": "credit_card",
  "signature_key": "23a7036edb8171b926e5292c7729c6bd26ed3250e22aead55110e34086dbc8fb393e7d3b7f764428a27c76e77d0a3bb6a7ba867066b2fbf5dae9e0f8a6c0dc0d",
  "status_code": "200",
  "transaction_id": "1ac1a089d-a587-40f1-a936-a7770667d6dd",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "0",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

JSON Attribute	Type	Description
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
approval_code	String	Approval code from payment provider for successful transaction, it can be used for refund
eci	String	The 3D Secure ECI Code
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
bank	String	The acquiring bank of the transaction
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider
card_type	String	Type of card used. Possible values: credit, debit

Card Features: One Click

One Click Initial Charge

Card Payment Initial One Click Charge

{
    "payment_type": "credit_card",
    "credit_card": {
        "token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
        "save_token_id": true     // <-- To flag that token is saved during initial charge
    },
    "transaction_details": {
        "order_id": "A87550",
        "gross_amount": 145000
    }
}

You need a Normal Token from Get Token to charge with One Click feature. Add additional attribute in charge request credit_card object when charging the initial transaction for One Click feature.

JSON Attribute	Type	Description
token_id	String	Token ID represents customer's credit card information acquired from Get Token Response
save_token_id	Boolean	A flag to indicate one click feature to return a saved_token_id which can be used for the next transaction

One Click Initial Charge Response and Notifications

Card Payment Initial One Click Charge Response

{
    "status_code": "200",
    "status_message": "Success, Credit Card 3D Secure transaction is successful",
    "transaction_id": "f50c0aef-b629-4a5b-957b-4c52f45e2e63",
    "order_id": "A87550",
    "payment_type": "credit_card",
    "transaction_time": "2014-08-25 11:21:48",
    "transaction_status": "capture",
    "fraud_status": "accept",
    "masked_card": "481111-1114",
    "saved_token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
    "saved_token_id_expired_at": "2024-08-25 11:21:48",            
    "approval_code": "1408940508666",
    "gross_amount": "145000.00",
    "bank": "bni",
    "channel_response_code": "00",
    "channel_response_message": "Approved",
    "currency": "IDR",
    "card_type": "credit"
}

Card Payment Initial One Click Notifications

{
  "masked_card": "481111-1114",
  "approval_code": "1408940508666",
  "bank": "bni",
  "eci": "05",
  "saved_token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
  "saved_token_id_expired_at": "2024-08-25 11:21:48",
  "transaction_time": "2014-08-25 11:21:48",
  "gross_amount": "145000.00",
  "order_id": "A87550",
  "payment_type": "credit_card",
  "signature_key": "c77f17bf6a8dee35c19f02f2c33f9e4a2ee61b4bad15370a9f0f149a96909c8d887a0e0cddeb47bd02e88f369422aee6e323aaf938bb7bc5c55228459babbdb1",
  "status_code": "200",
  "transaction_id": "f50c0aef-b629-4a5b-957b-4c52f45e2e63",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

One Click Initial Charge Response and Notifications are identical with Card Payment Charge Response and Notifications, with additional attributes:

JSON Attribute	Type	Description
saved_token_id	String	Token ID of a credit card to be charged for the following transaction
saved_token_id_expired_at	String	Expiry date of the Token ID

One Click Following Charge

Card Payment Following One Click Charge

{
    "payment_type": "credit_card",
    "credit_card": {
        "token_id": "44811117d16c884-2cc7-4624-b0a8-10273b7f6cc8"
    },
    "transaction_details": {
        "order_id": "A87551",
        "gross_amount": 145000
    }
}

You need saved_token_id from initial Charge Response in order to charge the following One Click transaction.

JSON Attribute	Type	Description
token_id	String	saved_token_id represents customer's credit card information acquired from One Click initial charge response

One Click Following Charge Response and Notifications

Following One Click Charge Response is identical with Card Payment Charge Response and Response. Successful One Click transaction is described as capture and is ready for settlement.

Card Features: Two Clicks

Two Clicks Initial Charge

Card Payment Initial Two Clicks Charge

{
    "payment_type": "credit_card",
    "credit_card": {
        "token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
        "save_token_id": true     // To flag that token is saved during initial charge
    },
    "transaction_details": {
        "order_id": "A87550",
        "gross_amount": 145000
    }
}

You need a Normal Token from Get Token for initial charge with Two Clicks feature. Add this additional attribute in charge request credit_card object when charging the initial transaction for Two Clicks feature.

JSON Attribute	Type	Description
token_id	String	Token ID represents customer's credit card information acquired from Get Token Response

Two Clicks Initial Charge Response and Notifications

Card Payment Initial Two Clicks Charge Response

{
    "status_code": "200",
    "status_message": "Success, Credit Card 3D Secure transaction is successful",
    "transaction_id": "f50c0aef-b629-4a5b-957b-4c52f45e2e63",
    "order_id": "A87550",
    "payment_type": "credit_card",
    "transaction_time": "2014-08-25 11:21:48",
    "transaction_status": "capture",
    "fraud_status": "accept",
    "masked_card": "481111-1114",
    "saved_token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
    "saved_token_id_expired_at": "2024-08-25 11:21:48",
    "approval_code": "1408940508666",
    "gross_amount": "145000.00",
    "bank": "bni",
    "channel_response_code": "00",
    "channel_response_message": "Approved",
    "currency": "IDR",
    "card_type": "credit"
}

Card Payment Initial Two Clicks notification

{
  "masked_card": "481111-1114",
  "approval_code": "1408940508666",
  "bank": "bni",
  "eci": "05",
  "saved_token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
  "saved_token_id_expired_at": "2024-08-25 11:21:48",
  "transaction_time": "2014-08-25 11:21:48",
  "gross_amount": "145000.00",
  "order_id": "A87550",
  "payment_type": "credit_card",
  "signature_key": "c77f17bf6a8dee35c19f02f2c33f9e4a2ee61b4bad15370a9f0f149a96909c8d887a0e0cddeb47bd02e88f369422aee6e323aaf938bb7bc5c55228459babbdb1",
  "status_code": "200",
  "transaction_id": "f50c0aef-b629-4a5b-957b-4c52f45e2e63",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Two Clicks Initial Charge Response is identical with Card Payment Charge Response, with the additional attributes:

JSON Attribute	Type	Description
saved_token_id	String	Token ID of a credit card to be charged for the following transaction
saved_token_id_expired_at	String	Expiry date of the Token ID

Two Clicks Following Charge

Card Payment Following Two Clicks Charge

{
    "payment_type": "credit_card",
    "credit_card": {
        "token_id": "481111-1114-7baba36c-5698-47cf-9170-80efd6a2e973"
    },
    "transaction_details": {
        "order_id": "A87551",
        "gross_amount": 145000
    }
}

You need the Two Clicks Token] from Get Token in order to charge the following two clicks transaction.

JSON Attribute	Type	Description
token_id	String	Token ID represents customer's credit card information acquired from Get Token Response

Two Clicks Following Payment Response and Notifications.

Following Two Clicks Charge Response is identical with Card Payment Charge Response and Notifications. Successful Two Clicks transaction is described as capture and is ready for settlement.

Card Features: Point

Card Payment Point Charge

{
    "payment_type": "credit_card",
    "credit_card": {
        "token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
        "point_redeem_amount": 145000
    },
    "transaction_details": {
        "order_id": "A87550",
        "gross_amount": 145000
    }
}

To perform point transaction, you need to supply point_redeem_amount parameter. You may get the value from Point Inquiry API. Currently, point transaction is only supported by BNI and Mandiri.

JSON Attribute	Type	Description
token_id	String	Token ID represents customer's credit card information acquired from Get Token Response
bank	String	Acquiring bank. To make sure the request is going on-us.
point_redeem_amount	Long	Amount to be redeemed with point (use -1 for Full Redemption) NOTE: For Mandiri Point, you can only do Full Redemption.

Point Charge Response and Notifications

Card Payment Point Charge Response

{
    "status_code": "200",
    "status_message": "Success, Credit Card 3D Secure transaction is successful",
    "transaction_id": "f50c0aef-b629-4a5b-957b-4c52f45e2e63",
    "order_id": "A87550",
    "payment_type": "credit_card",
    "transaction_time": "2014-08-25 11:21:48",
    "transaction_status": "capture",
    "fraud_status": "accept",
    "masked_card": "481111-1114",
    "point_redeem_amount": 145000,
    "point_redeem_quantity": 1450,
    "point_balance_amount": "0.00",
    "approval_code": "1408940508666",
    "gross_amount": "145000.00",
    "bank": "bni",
    "channel_response_code": "00",
    "channel_response_message": "Approved",
    "currency": "IDR"
}

Card Payment Point notification

{
  "masked_card": "481111-1114",
  "approval_code": "1408940508666",
  "bank": "bni",
  "eci": "05",
  "point_redeem_amount": 145000,
  "point_redeem_quantity": 1450,
  "point_balance_amount": "0.00",
  "transaction_time": "2014-08-25 11:21:48",
  "gross_amount": "145000.00",
  "order_id": "A87550",
  "payment_type": "credit_card",
  "signature_key": "c77f17bf6a8dee35c19f02f2c33f9e4a2ee61b4bad15370a9f0f149a96909c8d887a0e0cddeb47bd02e88f369422aee6e323aaf938bb7bc5c55228459babbdb1",
  "status_code": "200",
  "transaction_id": "f50c0aef-b629-4a5b-957b-4c52f45e2e63",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Point Charge Response is identical with Card Payment Charge Response, with the additional attributes:

JSON Attribute	Type	Description
point_redeem_amount	Long	Denomination amount redeemed
point_redeem_quantity	Long	Point representation of point_redeem_amount
point_balance_amount	String	Remaining denomination amount

Credit Card - Full PAN

Compared with normal credit card, Full PAN simplifies credit card recurring process by removing the tokenization step. This requires merchant to be PCI-DSS compliant.

To better understand the integration, we categorize it to Non-3DS and 3DS:

Non-3DS Integration

Complete charge request

{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "credit_card": {
    "card": {
      "number": "4811111111111114",
      "expiry_month": "3",
      "expiry_year": "2020",
      "cvv": "123"
    },
    "dynamic_descriptor": {
      "merchant_name": "Fuji Apple Inc",
      "city_name": "Jakarta",
      "country_code": "ID"
    }
  },
  "item_details": [{
      "id": "a1",
      "price": 145000,
      "quantity": 2,
      "name": "Apel",
      "brand": "Fuji Apple",
      "category": "Fruit",
      "merchant_name": "Fruit-store"
    }],
    "customer_details": {
      "first_name": "BUDI",
      "last_name": "UTOMO",
      "email": "test@midtrans.com",
      "phone": "+628123456",
      "billing_address": {
        "first_name": "BUDI",
        "last_name": "UTOMO",
        "email": "test@midtrans.com",
        "phone": "081 2233 44-55",
        "address": "Sudirman",
        "city": "Jakarta",
        "postal_code": "12190",
        "country_code": "IDN"
      },
      "shipping_address": {
        "first_name": "BUDI",
        "last_name": "UTOMO",
        "email": "test@midtrans.com",
        "phone": "0 8128-75 7-9338",
        "address": "Sudirman",
        "city": "Jakarta",
        "postal_code": "12190",
        "country_code": "IDN"
      }
    }
}

JSON Attribute	Type	Required	Description
payment_type	String (255)	Y	Set credit card payment method. Value is "credit_card"
transaction_details	Object	Y	Transaction details
credit_card	Object	Y	Charge details using credit card
item_details	Object	N	Shopping item details
customer_details	Object	N	Customer details

For Full PAN API, there are some parameters to note under the credit_card object:

JSON Attribute	Type	Required	Description
card.number	Numeric (13-19)	Y	Primary Account Number (PAN) of credit card.
card.expiry_month	Numeric (1-2)	Y	Credit card expiry month.
card.expiry_year	Numeric (4)	Y	Credit card expiry year.
card.cvv	Numeric (3-4)	N	Also known as Card Security Code (CSV) shown in the back of the credit card. NOTE: If cvv is not passed, then transaction will be treated as recurring
dynamic_descriptor.merchant_name	String (25)	N	First 25 digit on customer's billing statement. Mostly used to show the merchant or product name. Only works for BNI.
dynamic_descriptor.city_name	String (13)	N	Next 13 digit on customer's billing statement. It works as secondary metadata on the statement. Mostly used to show city name or region. Only works for BNI.
dynamic_descriptor.country_code	String (2)	N	Last 2 digit on customer's billing statement. Mostly used to show country code. Only works for BNI.

Integration steps:

1. Charge transaction
2. Handle notification

Non 3DS Full PAN Charge Response and Notifications

Successful Charge Response

{
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "order_id": "C17550",
  "gross_amount": "145000.00",
  "payment_type": "credit_card",
  "transaction_time": "2014-08-24 15:39:22",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "masked_card": "481111-1114",
  "status_code": "200",
  "bank": "bni",
  "status_message": "Success, Credit Card 3D Secure transaction is successful",
  "approval_code": "1408869563148",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "currency": "IDR",
  "card_type": "credit"
}

Denied Charge Response

{
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "order_id": "C17550",
  "gross_amount": "145000.00",
  "payment_type": "credit_card",
  "transaction_time": "2014-08-24 15:39:22",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "masked_card": "481111-1114",
  "status_code": "202",
  "bank": "bni",
  "status_message": "Deny by Bank [CIMB] with code [05] and message [Do not honour]",
  "approval_code": "      ",
  "channel_response_code": "05",
  "channel_response_message": "Do not honour",
  "currency": "IDR",
  "card_type": "credit"
}

Challenged Charge Response

{
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "order_id": "C17550",
  "gross_amount": "145000.00",
  "payment_type": "credit_card",
  "transaction_time": "2014-08-24 15:39:22",
  "transaction_status": "authorize",
  "fraud_status": "challenge",
  "masked_card": "481111-1114",
  "status_code": "201",
  "bank": "bni",
  "status_message": "Success, Credit Card 3D Secure transaction is successful",
  "approval_code": "1408869563148",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "currency": "IDR",
  "card_type": "credit"
}

Validation Error Response

{
    "status_code": "400",
    "status_message": "One or more parameters in the payload is invalid.",
    "id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
    "validation_messages": [
        "unsupported token request parameter(s)"
    ]
}

Settlement Notification

{
  "masked_card": "481111-1114",
  "approval_code": "131755",
  "bank": "bni",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "49e158a0c3f1913eae0902875324075c562daa39b2824b865db2242adea247a228960d2f1002392fdbc29c3271c2bc78ba72e588db9047a82932d0615ddc811f",
  "status_code": "200",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature.
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result
approval_code	String	Approval code. It can be used for refund. This does not exist on denied transaction
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider
currency	String	ISO-4217 representation for 3 digit alphabetic currency code
card_type	String	Type of card used. Possible values: credit, debit

3DS Integration

Complete charge request

{
  "payment_type": "credit_card",
  "transaction_details": {
    "order_id": "C17550",
    "gross_amount": 145000
  },
  "credit_card": {
    "card": {
      "number": "4811111111111114",
      "expiry_month": "3",
      "expiry_year": "2020",
      "cvv": "123"
    },
    "dynamic_descriptor": {
      "merchant_name": "Fuji Apple Inc",
      "city_name": "Jakarta",
      "country_code": "ID"
    },
    "authentication": true,
  },
  "item_details": [{
      "id": "a1",
      "price": 145000,
      "quantity": 2,
      "name": "Apel",
      "brand": "Fuji Apple",
      "category": "Fruit",
      "merchant_name": "Fruit-store"
    }],
    "customer_details": {
      "first_name": "BUDI",
      "last_name": "UTOMO",
      "email": "test@midtrans.com",
      "phone": "+628123456",
      "billing_address": {
        "first_name": "BUDI",
        "last_name": "UTOMO",
        "email": "test@midtrans.com",
        "phone": "081 2233 44-55",
        "address": "Sudirman",
        "city": "Jakarta",
        "postal_code": "12190",
        "country_code": "IDN"
      },
      "shipping_address": {
        "first_name": "BUDI",
        "last_name": "UTOMO",
        "email": "test@midtrans.com",
        "phone": "0 8128-75 7-9338",
        "address": "Sudirman",
        "city": "Jakarta",
        "postal_code": "12190",
        "country_code": "IDN"
      }
    }
}

JSON Attribute	Type	Required	Description
payment_type	String (255)	Y	Set credit card payment method. Value is "credit_card"
transaction_details	Object	Y	Transaction details
credit_card	Object	Y	Charge details using credit card
item_details	Object	N	Shopping item details
customer_details	Object	N	Customer Details

In addition to the parameters used for the Non 3DS Full PAN flow, there is a parameter to note under the credit_card object:

JSON Attribute	Type	Required	Description
authentication	Boolean	N	Flag to determine whether transaction should be authenticated for 3DS or not.
callback_type	String	N	Determine how the transaction status will be updated to the client side. Possible values: js_event (default) or form. More details will be explained here.

Integration steps:

1. Charge transaction
2. Open redirect_url
3. Handle notification

3DS Full PAN Charge Response and Notifications

Successful Charge Response

{
    "status_code": "201",
    "status_message": "Credit Card transaction is in progress",
    "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
    "order_id": "C17550",
    "redirect_url": "https://api.veritrans.co.id/v2/token/rba/redirect/451249-2595-e14aac7f-cfb3-4ab2-98ab-5cc5e70f4b2c",
    "gross_amount": "145000.00",
    "currency": "IDR",
    "payment_type": "credit_card",
    "transaction_time": "2018-09-12 22:10:23",
    "transaction_status": "pending",
    "masked_card": "481111-1114",
  "card_type": "credit"
}

Validation Error Response

{
    "status_code": "400",
    "status_message": "One or more parameters in the payload is invalid.",
    "id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
    "validation_messages": [
        "unsupported token request parameter(s)"
    ]
}

Capture Notification

{
  "masked_card": "481111-1114",
  "approval_code": "T58755",
  "bank": "bni",
  "eci": "05",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "8d22a6b625f395a1a2cf0e62497e20be433cbad3e8a8ff36bf6b40dbd47308125ccda93546eab8a3acd91390155082658ac25b10a6294c6660642e43a5edc8bb",
  "status_code": "200",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "capture",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Deny Notification

{
  "masked_card": "481111-1114",
  "approval_code": "338016",
  "bank": "bni",
  "eci": "06",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "763713b31cf59c886d3cc4a0c654a060a8e990080fe29fca75ae9e4ff9de804809c4e20977829844dac01a7ac1464a4eb095ad32482048398918987295dc5022",
  "status_code": "202",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "05",
  "channel_response_message": "Do not honor",
  "card_type": "credit"
}

Challenge Notification

{
  "masked_card": "481111-1114",
  "approval_code": "315762",
  "bank": "bni",
  "eci": "05",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "393f8b6b27f9f6385d8391642942e9534fd20dad20c0631b75b0746bfc314482af4411c93e958b691a63e9154676905b906234d1f12fca031f5be5593f7ec2c6",
  "status_code": "201",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "capture",
  "fraud_status": "challenge",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

Settlement Notification

{
  "masked_card": "481111-1114",
  "approval_code": "131755",
  "bank": "bni",
  "eci": "05",
  "transaction_time": "2014-08-24 15:39:22",
  "gross_amount": "145000.00",
  "order_id": "C17550",
  "payment_type": "credit_card",
  "signature_key": "49e158a0c3f1913eae0902875324075c562daa39b2824b865db2242adea247a228960d2f1002392fdbc29c3271c2bc78ba72e588db9047a82932d0615ddc811f",
  "status_code": "200",
  "transaction_id": "1a1a66f7-27a7-4844-ba1f-d86dcc16ab27",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification",
  "channel_response_code": "00",
  "channel_response_message": "Approved",
  "card_type": "credit"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status after charge credit card transaction, the possible values are capture : Transaction is accepted by the bank and ready for settlement. deny: transaction is denied by the bank or FDS. authorize: Credit card is authorized in pre-authorization feature
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
masked_card	String	First 6-digit and last 4-digit of customer's credit card number
status_code	String	Status code of transaction charge result
bank	String	The acquiring bank of the transaction
status_message	String	Description of transaction charge result
approval_code	String	Approval code. It can be used for refund. This does not exist on denied transaction
eci	String	The 3D secure ECI Code
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider
redirect_url	String	URL which needs to be opened by customer to finish 3DS authentication
currency	String	ISO-4217 representation for 3 digit alphabetic currency code
card_type	String	Type of card used. Possible values: credit, debit

Bank Transfer

One of the payment method offered by Midtrans is Bank Transfer. By using this payment method, customers will have the option to make a payment via bank transfer and Midtrans will send real time notification when the customer complete the payment.

At this moment, Midtrans has integrated with 4 different bank transfer payment methods:

• Permata Virtual Account
• BCA Virtual Account
• Mandiri Bill Payment
• BNI Virtual Account

Permata Virtual Account

NOTE: There may be cases where SETTLEMENT turns into DENY. It is caused by reversal triggered by corresponding payment provider. It may happen in the span of 1 minute.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Display the virtual account number.
3. Handle notification.

Permata Virtual Account Charge

{
  "payment_type": "bank_transfer",
  "bank_transfer": {
    "bank": "permata",
    "permata": {
      "recipient_name": "SUDARSONO"
    }
  },
  "transaction_details": {
    "order_id": "H17550",
    "gross_amount": 145000
  }
}

Following attributes are required to charge Permata Virtual Account:

JSON Attribute	Type	Description
payment_type	String	Set Bank Transfer payment method. Value: bank_transfer
transaction_details	Object	Transaction details
bank_transfer	Object	Charge details using bank transfer
item_details	Object	Shopping item details will be paid by customer
customer_details	Object	Customer Details

Permata Virtual Account Response and notification

Permata Virtual Account Charge Response

{
  "status_code": "201",
  "status_message": "Success, PERMATA VA transaction is successful",
  "transaction_id": "6fd88567-62da-43ff-8fe6-5717e430ffc7",
  "order_id": "H17550",
  "gross_amount": "145000.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-06-19 13:42:29",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "permata_va_number": "8562000087926752"
}

Permata Virtual Account Pending Notification

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "6fd88567-62da-43ff-8fe6-5717e430ffc7",
  "order_id": "H17550",
  "gross_amount": "145000.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-06-19 13:42:29",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "permata_va_number": "8562000087926752",
  "signature_key": "66aa11a65b18e9ee5da966ed18d5d2163812000eee37824ceb59aba1ded005e992e05a7dfac39098ebdb0e2c8b484e140b586246d34b4ca313c690cc6eae48cf"
}

Permata Virtual Account Settlement notification

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "6fd88567-62da-43ff-8fe6-5717e430ffc7",
  "order_id": "H17550",
  "gross_amount": "145000.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-06-19 18:23:21",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "permata_va_number": "8562000087926752",
  "signature_key": "0c0df82489931602577d9e434966c0540249b7c0aeaae2b718305af89a11e2bf9b4008aba07d1b3b248b15b4fbecdd15e81dbb2648b974efc4e0656e8c976094"
}

Permata Virtual Account Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "6fd88567-62da-43ff-8fe6-5717e430ffc7",
  "order_id": "H17550",
  "gross_amount": "145000.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-06-20 13:42:30",
  "transaction_status": "expire",
  "fraud_status": "accept",
  "permata_va_number": "8562000087926752",
  "signature_key": "f1066b06ec8a4b7d6ffb941fd9772f6df304618e15e02cf17c2914cec12793e19c71653042f7f617b027eae6ecb6759529c67eca9af55264b736408d8b4df2b9"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of bank transfer transaction, the possible value is pending : Bank Transfer transaction is created
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS.
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
permata_va_number	String	Generated Virtual Account number. Customer has to know this number to complete the payment

BCA Virtual Account

Integration steps:

1. Merchant send charge request to Midtrans.
2. Display the virtual account number.
3. Handle notification.

BCA Virtual Account Charge

{
    "payment_type": "bank_transfer",
    "transaction_details": {
        "gross_amount": 10000,
        "order_id": "{{$timestamp}}"
    },
    "customer_details": {
        "email": "budi.utomo@Midtrans.com",
        "first_name": "budi",
        "last_name": "utomo",
        "phone": "+6281 1234 1234"
    },
    "item_details": [
    {
       "id": "1388998298204",
       "price": 5000,
       "quantity": 1,
       "name": "Ayam Zozozo"
    },
    {
       "id": "1388998298205",
       "price": 5000,
       "quantity": 1,
       "name": "Ayam Xoxoxo"
    }
   ],
   "bank_transfer":{
     "bank": "bca",
     "va_number": "111111",
     "free_text": {
          "inquiry": [
                {
                    "id": "Free Text ID Free Text ID Free Text ID",
                    "en": "Free Text EN Free Text EN Free Text EN"
                }
          ],
          "payment": [
                {
                    "id": "Free Text ID Free Text ID Free Text ID",
                    "en": "Free Text EN Free Text EN Free Text EN"
                }
          ]
    },
    "bca": {
        "sub_company_code": "00000"
    }
  }
}

Following attributes are required to charge BCA Virtual Account:

JSON Attribute	Type	Description
payment_type	String	Set Bank Transfer payment method. Value: bank_transfer
transaction_details	Object	Transaction details
bank_transfer	Object	Charge details using bank transfer
item_details	Object	Shopping item details will be paid by customer
customer_details	Object	Customer Details

BCA Virtual Account Response and notification

BCA Virtual Account Charge Response

{
  "status_code": "201",
  "status_message": "Success, Bank Transfer transaction is created",
  "transaction_id": "9aed5972-5b6a-401e-894b-a32c91ed1a3a",
  "order_id": "1466323342",
  "gross_amount": "20000.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-06-19 15:02:22",
  "transaction_status": "pending",
  "va_numbers": [
    {
      "bank": "bca",
      "va_number": "91019021579"
    }
  ],
  "fraud_status": "accept",
  "currency": "IDR"
}

BCA Virtual Account Pending notification

{
  "va_numbers": [
    {
      "bank": "bca",
      "va_number": "91019021579"
    }
  ],
  "transaction_time": "2016-06-19 15:02:22",
  "gross_amount": "20000.00",
  "order_id": "1466323342",
  "payment_type": "bank_transfer",
  "signature_key": "74d9b6f4cc36585d74e06c9dba360331e455171bcec35df60cf28a786436f8f96e6afcc1f091d6cb61411aec246ac28ba30b76d9b2c1cdb6409c0a70fcc1fe47",
  "status_code": "201",
  "transaction_id": "a9aed5972-5b6a-401e-894b-a32c91ed1a3a",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

BCA Virtual Account Settlement notification

{
  "va_numbers": [
    {
      "bank": "bca",
      "va_number": "91019021579"
    }
  ],
  "transaction_time": "2016-06-19 19:12:22",
  "gross_amount": "20000.00",
  "order_id": "1466323342",
  "payment_type": "bank_transfer",
  "signature_key": "fe5f725ea770c451017e9d6300af72b830a668d2f7d5da9b778ec2c4f9177efe5127d492d9ddfbcf6806ea5cd7dc1a7337c674d6139026b28f49ad0ea1ce5107",
  "status_code": "200",
  "transaction_id": "9aed5972-5b6a-401e-894b-a32c91ed1a3a",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

BCA Virtual Account Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "9aed5972-5b6a-401e-894b-a32c91ed1a3a",
  "order_id": "1466323342",
  "gross_amount": "20000.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-06-20 15:02:23",
  "transaction_status": "expire",
  "signature_key": "e4e829a5d9a1e342daf181c5fd750afa64dd5a5c9a6e0cfb636e7966295b2613fda22b4dc52b01c30618a50ff3524f57ec661a9dced249df93f163138a0df6b0"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of bank transfer transaction, the possible value is pending : Bank Transfer transaction is created
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS.
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
va_numbers	Array of JSON	Generated Virtual Account number and virtual account bank

Mandiri Bill Payment

NOTE: There may be cases where SETTLEMENT turns into DENY. It is caused by reversal triggered by corresponding payment provider. It may happen in the span of 1 minute.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Display bill key and biller code to the customer.
3. Handle notification.

Mandiri Bill Payment Charge

{
    "payment_type": "echannel",
    "transaction_details": {
        "order_id": "1388",
        "gross_amount": 95000
        },
    "item_details": [
        {
          "id": "a1",
          "price": 50000,
          "quantity": 2,
          "name": "Apel"
        },
        {
         "id": "a2",
          "price": 45000,
          "quantity": 1,
          "name": "Jeruk"
        }
    ],
    "echannel" : {
        "bill_info1" : "Payment For:",
        "bill_info2" : "debt"
    }
}

The following attribute can be used to perform a charge transaction with Mandiri Bill Payment:

JSON Attribute	Type	Description
payment_type	String	Set E-channel payment method. Value: echannel
transaction_details	Object	Transaction details
echannel	Object	Charge details using Mandiri Bill Payment
item_details	Object	Shopping item details will be paid by customer
customer_details	Object	Customer Details

Mandiri Bill Response

Mandiri Bill Payment Charge Response

{
  "status_code": "201",
  "status_message": "Success, Mandiri Bill transaction is successful",
  "transaction_id": "883af6a4-c1b4-4d39-9bd8-b148fcebe853",
  "order_id": "tes",
  "gross_amount": "1000.00",
  "payment_type": "echannel",
  "transaction_time": "2016-06-19 14:40:19",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "bill_key": "990000000260",
  "biller_code": "70012",
  "currency": "IDR"
}

Mandiri Bill Payment Pending notification

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "883af6a4-c1b4-4d39-9bd8-b148fcebe853",
  "order_id": "tes",
  "gross_amount": "1000.00",
  "payment_type": "echannel",
  "transaction_time": "2016-06-19 14:40:19",
  "transaction_status": "pending",
  "signature_key": "d1ebf5bf14a7c96ca58e719832de459898f61fa8d81560f59e9a38a5187383b1d507e3075277d9b1c6227926fc8a0448e164f1b9de33c8141f81c57b87d23775",
  "bill_key": "990000000260",
  "biller_code": "70012"
}

Mandiri Bill Payment Settlement notification

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "883af6a4-c1b4-4d39-9bd8-b148fcebe853",
  "order_id": "tes",
  "gross_amount": "1000.00",
  "payment_type": "echannel",
  "transaction_time": "2016-06-19 15:10:29",
  "transaction_status": "settlement",
  "approval_code": "340093197",
  "signature_key": "bbceb3724b0b2446c59435795039fed2d249d3438f06bf90c999cc9d383b95170b7b58f9412fba25ce7756da8075ab1d78a48800156380a62dc84eb22b3f7de9",
  "bill_key": "990000000260",
  "biller_code": "70012"
}

Mandiri Bill Payment Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "883af6a4-c1b4-4d39-9bd8-b148fcebe853",
  "order_id": "tes",
  "gross_amount": "1000.00",
  "payment_type": "echannel",
  "transaction_time": "2016-06-20 14:40:19",
  "transaction_status": "expire",
  "signature_key": "69ef827242b29640a1193b6c2f32ba1374c04b969f7723984a6c676349ee7927cb6b263546d138e3a5c788829fbc4f114353b67becad2af7a86b1b741fc8d80a",
  "bill_key": "990000000260",
  "biller_code": "70012"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of bank transfer transaction, the possible value is pending : Bank Transfer transaction is created
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS.
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
biller_code	String	Midtrans Unique Biler Code Number. Value is 70012
bill_key	String	Merchant Biller Key ID to perform transaction

BNI Virtual Account

Integration steps:

1. Merchant send charge request to Midtrans.
2. Display the virtual account number.
3. Handle notification.

BNI Virtual Account Charge

{
    "payment_type": "bank_transfer",
    "transaction_details": {
        "gross_amount": 10000,
        "order_id": "{{$timestamp}}"
    },
    "customer_details": {
        "email": "budi.utomo@Midtrans.com",
        "first_name": "budi",
        "last_name": "utomo",
        "phone": "+6281 1234 1234"
    },
    "item_details": [
    {
       "id": "1388998298204",
       "price": 5000,
       "quantity": 1,
       "name": "Ayam Zozozo"
    },
    {
       "id": "1388998298205",
       "price": 5000,
       "quantity": 1,
       "name": "Ayam Xoxoxo"
    }
   ],
   "bank_transfer":{
     "bank": "bni",
     "va_number": "111111"
  }
}

Following attributes are required to charge BNI Virtual Account:

JSON Attribute	Type	Description
payment_type	String	Set Bank Transfer payment method. Value: bank_transfer
transaction_details	Object	Transaction details
bank_transfer	Object	Charge details using bank transfer
item_details	Object	Shopping item details will be paid by customer
customer_details	Object	Customer Details

BNI Virtual Account Response and notification

BNI Virtual Account Charge Response

{
  "status_code": "201",
  "status_message": "Success, Bank Transfer transaction is created",
  "transaction_id": "9aed5972-5b6a-401e-894b-a32c91ed1a3a",
  "order_id": "1466323342",
  "gross_amount": "20000.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-06-19 15:02:22",
  "transaction_status": "pending",
  "va_numbers": [
    {
      "bank": "bni",
      "va_number": "8578000000111111"
    }
  ],
  "fraud_status": "accept",
  "currency": "IDR"
}

BNI Virtual Account Pending notification

{
  "va_numbers": [
    {
      "bank": "bni",
      "va_number": "8578000000111111"
    }
  ],
  "transaction_time": "2016-06-19 15:02:22",
  "gross_amount": "20000.00",
  "order_id": "1466323342",
  "payment_type": "bank_transfer",
  "signature_key": "74d9b6f4cc36585d74e06c9dba360331e455171bcec35df60cf28a786436f8f96e6afcc1f091d6cb61411aec246ac28ba30b76d9b2c1cdb6409c0a70fcc1fe47",
  "status_code": "201",
  "transaction_id": "a9aed5972-5b6a-401e-894b-a32c91ed1a3a",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

BNI Virtual Account Settlement notification

{
  "va_numbers": [
    {
      "bank": "bni",
      "va_number": "8578000000111111"
    }
  ],
  "payment_amounts": [
    {
      "paid_at": "2016-06-19 20:12:22",
      "amount": "20000.00"
    }
  ],
  "transaction_time": "2016-06-19 19:12:22",
  "gross_amount": "20000.00",
  "order_id": "1466323342",
  "payment_type": "bank_transfer",
  "signature_key": "fe5f725ea770c451017e9d6300af72b830a668d2f7d5da9b778ec2c4f9177efe5127d492d9ddfbcf6806ea5cd7dc1a7337c674d6139026b28f49ad0ea1ce5107",
  "status_code": "200",
  "transaction_id": "9aed5972-5b6a-401e-894b-a32c91ed1a3a",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

BNI Virtual Account Expired notification

Send again
{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "9aed5972-5b6a-401e-894b-a32c91ed1a3a",
  "order_id": "1466323342",
  "gross_amount": "20000.00",
  "payment_type": "bank_transfer",
  "transaction_time": "2016-06-20 15:02:23",
  "transaction_status": "expire",
  "signature_key": "e4e829a5d9a1e342daf181c5fd750afa64dd5a5c9a6e0cfb636e7966295b2613fda22b4dc52b01c30618a50ff3524f57ec661a9dced249df93f163138a0df6b0"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of bank transfer transaction, the possible value is pending : Bank Transfer transaction is created
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS.
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
va_numbers	Array of JSON	Generated Virtual Account number and virtual account bank
payment_amounts	Array of JSON	Payment histories for the transaction

Internet Banking

Internet banking payment methods allow the customer to pay using their internet banking account and debit their saving account in order to pay online transaction. At this moment, Midtrans has integrated with 5 different internet banking payment method:

• BCA Klikpay
• Klikbca
• Mandiri Clickpay
• Epay BRI
• CIMB Clicks
• Danamon Online Banking (DOB)

BCA Klikpay

BCA Klikpay Charge

{
  "payment_type": "bca_klikpay",
  "transaction_details": {
    "order_id": "orderid-01",
    "gross_amount": 11000
  },
  "item_details": [
    {
      "id": "1",
      "price": 11000,
      "quantity": 1,
      "name": "Mobil "
    }
  ],
  "customer_details":{
    "first_name": "John",
    "last_name": "Baker",
    "email": "john.baker@email.com",
    "phone": "08123456789"
  },
  "bca_klikpay": {
    "description": "Pembelian Barang"
  }
}

BCA KlikPay is the online banking payment method provided by BCA. This method allows customer to perform transaction using either their internet banking account or their private-label BCA credit card. The highly secure payment method, utilizes an SMS token for user validation.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Do redirection to address specified in the response.
3. Handle notification.

Following attributes are required to charge BCA Klikpay:

JSON Attribute	Type	Description
payment_type	String	Set BCA Klikpay payment method. Value: bca_klikpay
transaction_details	Object	Details of the transaction will be paid by customer
bca_klikpay	Object	Charge details using BCA Klikpay
item_details	Object	Shopping item details
customer_details	Object	Customer Details

BCA Klikpay Charge Response and notification

BCA Klikpay Charge Response

{
  "status_code": "201",
  "status_message": "OK, BCA KlikPay transaction is successful",
  "transaction_id": "ada84cd9-2233-4c67-877a-01884eece45e",
  "order_id": "orderid-01",
  "redirect_url": "https://api.sandbox.veritrans.co.id/v3/bca/klikpay/redirect/ada84cd9-2233-4c67-877a-01884eece45e",
  "gross_amount": "11000.00",
  "payment_type": "bca_klikpay",
  "transaction_time": "2016-06-19 15:42:36",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "currency": "IDR"
}

BCA Klikpay Pending notification

{
  "transaction_time": "2016-06-19 15:42:36",
  "gross_amount": "11000.00",
  "order_id": "orderid-01",
  "payment_type": "bca_klikpay",
  "signature_key": "e47d73b2a10347d291e85a7c39c5fa2a7b760f0af7d9882f9c1b26db06e1af948968184b78f67112158cdeddd2141fe41068fdb37361ce11c3d2509354224a80",
  "status_code": "201",
  "transaction_id": "ada84cd9-2233-4c67-877a-01884eece45e",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

BCA Klikpay Settlement notification

{
  "approval_code": "91231",
  "transaction_time": "2016-06-19 15:46:16",
  "gross_amount": "11000.00",
  "order_id": "orderid-01",
  "payment_type": "bca_klikpay",
  "signature_key": "35c4111539e184b268b7c1cd62a9c254e5d27c992c8fd55084f930b69b09eaafcfe14b0d512c697648295fdb45de777e1316b401f4729846a91b3de88cde3f05",
  "status_code": "200",
  "transaction_id": "ada84cd9-2233-4c67-877a-01884eece45e",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

BCA Klikpay Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "ada84cd9-2233-4c67-877a-01884eece45e",
  "order_id": "orderid-01",
  "gross_amount": "11000.00",
  "payment_type": "bca_klikpay",
  "transaction_time": "2016-06-19 17:42:38",
  "transaction_status": "expire",
  "fraud_status": "accept",
  "signature_key": "62a8c432bb5a288a0495dd4f868b0aede4535e0c8a9fbebb3c6e9d4ea0db6f1963e551e70a99e80512030afa5ba8268f9be7b17b13a422ebef4620988c55d5ed"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of BCA Klikpay transaction, the possible value is pending
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
redirect_url	String	Redirect URL to BCA Klikpay payment page

Klikbca

Klikbca Charge

"payment_type" : "bca_klikbca",
"bca_klikbca" : {
   "description" : "testing transaction",
   "user_id" : "midtrans1012"
 },
"transaction_details" : {
   "order_id" : "3176440",
   "gross_amount" : "50000.00"
 },
 "item_details": [
   {
     "id": "1",
     "price": 50000,
     "quantity": 1,
     "name": "Mobil "
   }
 ],
 "customer_details" : {
   "first_name" : "Budi",
   "last_name" : "435547",
   "email" : "budi.utomo@yahoo.com"
 }

KlikBCA is an online banking payment method provided by BCA. This method allows customer to perform online transaction and complete the payment using BCA internet banking. Klikbca payment method utilizes BCA token for validation.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Do redirection to address specified in the response.
3. Handle notification.

Following attributes are required to charge BCA Klikpay:

JSON Attribute	Type	Description
payment_type	String	Set Klikbca payment method. Value: bca_klikbca
transaction_details	Object	Details of the transaction will be paid by customer
bca_klikbca	Object	Charge details using Klikbca
item_details	Object	Shopping item details
customer_details	Object	Customer Details

Klikbca Charge Response and notification

Klikbca Charge Response

{
  "status_code": "201",
  "status_message": "Success, KlikBCA transaction is successful",
  "redirect_url": "https://www.klikbca.com",
  "transaction_id": "c0ba3583-5111-45a5-9f1c-84c9de7cb2f6",
  "order_id": "3176440",
  "gross_amount": "50000.00",
  "payment_type": "bca_klikbca",
  "transaction_time": "2016-06-19 15:53:25",
  "transaction_status": "pending",
  "approval_code": "tes01"
}

Klikbca Pending notification

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "c0ba3583-5111-45a5-9f1c-84c9de7cb2f6",
  "order_id": "3176440",
  "gross_amount": "50000.00",
  "payment_type": "bca_klikbca",
  "transaction_time": "2016-06-19 15:53:25",
  "transaction_status": "pending",
  "approval_code": "YCB62E160704",
  "signature_key": "d4ae557ea12a03eed51714693b84e48665af5289bc53df9bae0fda7e3c6b6c03fd0b00bf1978d1932d9c718c5bb27bf1148e85401221df45daf4472a3b8ef30e",
}

Klikbca Settlement notification

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "c0ba3583-5111-45a5-9f1c-84c9de7cb2f6",
  "order_id": "3176440",
  "gross_amount": "50000.00",
  "payment_type": "bca_klikbca",
  "transaction_time": "2016-06-19 15:58:15",
  "transaction_status": "settlement",
  "approval_code": "YCRHOM160704",
  "signature_key": "ef0f472fa8a5165dc9f2ff6300832eb28657e88b9f3335ae5ebb27c8ef258d203c6da18ac6cd5738d2e38c54dfec860d8e067bdbc759a1268ab04218ccab93cc",
}

Klikbca Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "c0ba3583-5111-45a5-9f1c-84c9de7cb2f6",
  "order_id": "3176440",
  "gross_amount": "50000.00",
  "payment_type": "bca_klikbca",
  "transaction_time": "2016-06-19 17:53:25",
  "transaction_status": "expire",
  "approval_code": "3176440",
  "signature_key": "17b0e97425a3e967b91fccab2261f7b26ce8fc79612bf1ea700b503f8a812213d51d171045c084b29ca2d56db69a2ff3fed813ca1ff8f3377baafcf005bdb6bf"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of Klikbca transaction, the possible value is pending
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
redirect_url	String	Redirect URL to Klikbca payment page
approval_code	String	Successful Klikbca transaction approval code

Mandiri Clickpay

Mandiri Clickpay Charge

{
  "payment_type": "mandiri_clickpay",
  "mandiri_clickpay": {
    "token_id": "4111117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
    "input3": "54321",
    "token": "000000"
  },
  "item_details": [
    {
      "id": "1",
      "price": 11000,
      "quantity": 1,
      "name": "Mobil "
    }
  ],
  "transaction_details": {
    "order_id": "E17550",
    "gross_amount": 11000
  },
  "customer_details": {
    "first_name": "Andri",
    "last_name": "Litani",
    "email": "andri@litani.com",
    "phone": "081122334455"
  }
}

Mandiri Clickpay is one of the internet banking payment methods that is provided by Mandiri Bank. This method allows the customer to perform transactions by filling in his 16 digits Mandiri Debit Card number and Mandiri PIN Token to validate transactions.

Integration steps:

1. Exchange card data (consisting of the card number only) for a token_id.
2. Merchant send charge request to Midtrans with the previous token_id.
3. Handle notification.

Mandiri Clickpay requires user to send card data on client side in exchange for token_id like Credit Card payment flow. Contrary to Credit Card get token, Mandiri Clickpay requires only card_number parameter.

For implementation details please refer to Get Token API.

Following attributes are required to charge Mandiri Clickpay:

JSON Attribute	Type	Description
payment_type	String	Set Mandiri Clickpay payment method. Value: mandiri_clickpay
transaction_details	Object	Details of the transaction will be paid by customer
mandiri_clickpay	Object	Charge details using Mandiri Clikcpay Symbol Meaning token_id Token requested in exchange for the card_number input3 5-digits random number given to the customer token Number received by customer's physical token after input1 (Last 10 digits of card_number), input2 (Equivalent to gross_amount), and input3 are entered.
item_details	Object	Shopping item details
customer_details	Object	Customer Details

Mandiri Clickpay Charge Response and notification

Mandiri Clickpay Charge Response

{
    "status_code": "200",
    "status_message": "Success, Mandiri Clickpay transaction is successful",
    "transaction_id": "3bdddabe-a4ea-4233-81cc-09578178909f",
    "order_id": "100248319",
    "gross_amount": "156216.00",
    "payment_type": "mandiri_clickpay",
    "transaction_time": "2016-06-19 15:56:45",
    "transaction_status": "settlement",
    "fraud_status": "accept",
    "approval_code": "166JF5644001"
}

Mandiri Clickpay Settlement notification

{
  "approval_code": "166JF5644001",
  "transaction_time": "2016-06-19 15:56:45",
  "gross_amount": "156216.00",
  "order_id": "100248319",
  "payment_type": "mandiri_clickpay",
  "signature_key": "1e5d08e7f53cf0d4d07c85ad807fc091e59f579807b5a2e9728cb8d9ab11431d61673450944ef3fa7a87d7d2dbce8e90dc96012fc9950e3eb2d52521d5120a57",
  "status_code": "200",
  "transaction_id": "3bdddabe-a4ea-4233-81cc-09578178909f",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

Mandiri Clickpay Deny notification

{
  "transaction_time": "2016-06-19 15:56:45",
  "gross_amount": "156216.00",
  "order_id": "100248319",
  "payment_type": "mandiri_clickpay",
  "signature_key": "c2bdfd8d1b25100f5512b2573ecad8f2d324837a731362491b5a6b0bbd7ec74a032010754129f4c74f77a21796f747258ea611a3d5710648f63342570cdd0bb4",
  "status_code": "202",
  "transaction_id": "3bdddabe-a4ea-4233-81cc-09578178909f",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of Mandiri Clickpay transaction, the possible value is settlement for successful transaction or deny for failed transaction
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
approval_code	String	Successful Mandiri Clickpay transaction approval code

Epay BRI

Epay BRI Charge

{
  "payment_type": "bri_epay",
  "transaction_details": {
    "order_id": "2014111702",
    "gross_amount": 11000
  },
  "item_details": [
    {
      "id": "1",
      "price": 11000,
      "quantity": 1,
      "name": "Mobil "
    }
  ],
  "customer_details" : {
    "first_name": "Andri",
    "last_name": "Litani", // Optional
    "email": "andri@litani.com",
    "phone": "081122334455"
  }
}

e-Pay BRI is one of the internet banking payment methods provided by BRI Bank. This method allows customers to perform transactions by redirecting the customer to the e-Pay BRI payment page.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Do redirection to address specified in the response.
3. Handle notification.

Following attributes are required to charge Epay BRI:

JSON Attribute	Type	Description
payment_type	String	Set Epay BRI payment method. Value: bri_epay
transaction_details	Object	Details of the transaction will be paid by customer
item_details	Object	Shopping item details
customer_details	Object	Customer Details

Epay BRI Charge Response and notification

Epay BRI Charge Response

{
    "status_code": "201",
    "status_message": "Success, BRI E-Pay transaction is successful",
    "transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
    "order_id": "2014111702",
    "redirect_url": "https://api.veritrans.co.id/v3/bri/epay/redirect/f8635cd7-615d-4a6d-a806-c9ca4a56257e",
    "gross_amount": "145000.00",
    "payment_type": "bri_epay",
    "transaction_time": "2016-06-19 16:00:05",
    "transaction_status": "pending",
    "fraud_status": "accept",
    "currency": "IDR"
}

Epay BRI Pending notification

{
  "transaction_time": "2016-06-19 16:00:05",
  "gross_amount": "145000.00",
  "order_id": "2014111702",
  "payment_type": "bri_epay",
  "signature_key": "2ea1c4b7d7a41700848bbd248b85dd933e9fdff1f4d69fefa8eefac2bf92ac8a78dbc40a78b5d77315b704150bca14fcb76a4c770336295c63369c592787a03f",
  "status_code": "201",
  "transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

Epay BRI Settlement notification

{
  "approval_code": "201373311528",
  "transaction_time": "2016-06-19 16:04:02",
  "gross_amount": "145000.00",
  "order_id": "2014111702",
  "payment_type": "bri_epay",
  "signature_key": "13b6b8a2da46428812e7685463770e3704ece7fc3242a5f016f068b7b135e12a71afd02259fe4dbd8c97d747ae9cf8e13412842325ea8da4cf6d7177e32b7e31",
  "status_code": "200",
  "transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

Epay BRI Deny notification

{
  "transaction_time": "2016-06-19 16:04:02",
  "gross_amount": "145000.00",
  "order_id": "2014111702",
  "payment_type": "bri_epay",
  "signature_key": "6f4c3f00e391e2a97199ace0c243419b12c58eb9ec698600c25f8e9103573ef5258460484d64d742a4cd221cef33b57e23c1a31efa2480e1490d89163b8079bc",
  "status_code": "202",
  "transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

Epay BRI Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "f8635cd7-615d-4a6d-a806-c9ca4a56257e",
  "order_id": "2014111702",
  "gross_amount": "145000.00",
  "payment_type": "bri_epay",
  "transaction_time": "2016-06-19 18:00:05",
  "transaction_status": "expire",
  "signature_key": "75969ac3cd1538b860ddb49fce06084eae991093d6d7c4fb653efd0beb19b0f31b3e9c9568f1c1eae3deb988b379a2d7fb5dbf0099190d1a241fc07f4e4a82ed",
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of Epay BRI transaction, the possible value is pending
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
redirect_url	String	Redirect URL to Epay BRI payment page

CIMB Clicks

{
  "payment_type": "cimb_clicks",
  "cimb_clicks": {
    "description": "Purchase of a special event item"
  },
  "item_details": [
    {
      "id": "1",
      "price": 11000,
      "quantity": 1,
      "name": "Mobil "
    }
  ],
  "transaction_details": {
    "order_id": "H17550",
    "gross_amount": 11000
  },
  "customer_details" : {
    "first_name": "Andri",
    "last_name": "Litani",
    "email": "andri@litani.com",
    "phone": "081122334455"
  }
}

CIMB Clicks is one of the internet banking payment methods that is provided by CIMB Niaga Bank. This method allows the customer to perform a transaction by redirecting the customer to the CIMB Clicks payment page.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Do redirection to address specified in the response.
3. Handle notification.

Following attributes are required to charge CIMB Clicks:

JSON Attribute	Type	Description
payment_type	String	Set CIMB Clicks payment method. Value: cimb_clicks
transaction_details	Object	Details of the transaction will be paid by customer
cimb_clicks	Object	Charge details using CIMB Clicks
item_details	Object	Shopping item details
customer_details	Object	Customer Details

CIMB Clicks Charge Response and Notifications

CIMB Clicks Charge Response

{
  "status_code": "201",
  "status_message": "Success, CIMB Clicks transaction is successful",
  "redirect_url": "https://api.midtrans.com/cimb-clicks/request?id=226f042f-020e-4829-8bd7-2de64b8673ce",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 16:41:25",
  "transaction_status": "pending"
}

CIMB Clicks Pending notification

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 16:41:25",
  "transaction_status": "pending",
  "signature_key": "666617ddc981eb096b6f08ab8ee132b93c12d3b5b3817f00a02c5d4c71bd53fd7f39d55a92b2a1f729ee070fdb241b569dc90bfa61e41de16904075238d67d55",
}

CIMB Clicks Settlement notification

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 16:45:21",
  "transaction_status": "settlement",
  "approval_code": "RB5031388093",
  "signature_key": "3bcdf0700d3c8a288f279e4fe27a4012e916cb44120d541f6e4c48c83a107b605fdb063ae7c8744d15891047aeb1fc8d2e95741c0abc5f67e10e0b60244bc441"
}

CIMB Clicks Deny notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 16:44:21",
  "transaction_status": "deny",
  "signature_key": "b736864661f8cbf04b287ee5a9514589dbe2dc53e3949338d648144b6bad1bc77d1b495921f119e7a6bf5521b697ea5d629b5ea93f2bcda4ff13df744cfbf701"
}

CIMB Clicks Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "cimb_clicks",
  "transaction_time": "2016-06-19 18:41:25",
  "transaction_status": "expire",
  "signature_key": "3f1ddaf45b269df7a1638d6d4080957e1323df2cbc2da83549f86a23b17c2acae0215994bb60805455daf157125990414259e5319e84c9288fd6222e655c6756"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of CIMB Clicks transaction, the possible value is pending
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
redirect_url	String	Redirect URL to CIMB Clicks payment page

Danamon Online Banking

{
  "payment_type": "danamon_online",
  "item_details": [
    {
      "id": "1",
      "price": 11000,
      "quantity": 1,
      "name": "Mobil "
    }
  ],
  "transaction_details": {
    "order_id": "H17550",
    "gross_amount": 11000
  },
  "customer_details" : {
    "first_name": "Andri",
    "last_name": "Litani",
    "email": "andri@litani.com",
    "phone": "081122334455"
  }
}

Danamon Online Banking (DOB) is one of the internet banking payment methods that is provided by Danamon Bank. This method allows the customer to perform a transaction by redirecting the customer to the DOB payment page.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Do redirection to address specified in the response.
3. Handle notification.

Following attributes are required to charge DOB:

JSON Attribute	Type	Description
payment_type	String	Set DOB payment method. Value: danamon_online
transaction_details	Object	Details of the transaction will be paid by customer
item_details	Object	Shopping item details
customer_details	Object	Customer Details

DOB Charge Response and Notifications

DOB Charge Response

{
  "status_code": "201",
  "status_message": "Success, Danamon Online transaction is successful",
  "redirect_url": "https://api.midtrans.com/cimb-clicks/request?id=226f042f-020e-4829-8bd7-2de64b8673ce",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "danamon_online",
  "transaction_time": "2016-06-19 16:41:25",
  "transaction_status": "pending",
  "fraud_status": "accept"
}

DOB Pending notification

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "danamon_online",
  "transaction_time": "2016-06-19 16:41:25",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "signature_key": "666617ddc981eb096b6f08ab8ee132b93c12d3b5b3817f00a02c5d4c71bd53fd7f39d55a92b2a1f729ee070fdb241b569dc90bfa61e41de16904075238d67d55",
}

DOB Settlement notification

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "danamon_online",
  "transaction_time": "2016-06-19 16:45:21",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "approval_code": "RB5031388093",
  "signature_key": "3bcdf0700d3c8a288f279e4fe27a4012e916cb44120d541f6e4c48c83a107b605fdb063ae7c8744d15891047aeb1fc8d2e95741c0abc5f67e10e0b60244bc441"
}

DOB Deny notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "danamon_online",
  "transaction_time": "2016-06-19 16:44:21",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "signature_key": "b736864661f8cbf04b287ee5a9514589dbe2dc53e3949338d648144b6bad1bc77d1b495921f119e7a6bf5521b697ea5d629b5ea93f2bcda4ff13df744cfbf701"
}

DOB Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "226f042f-020e-4829-8bd7-2de64b8673ce",
  "order_id": "1000156414164125",
  "gross_amount": "392127.00",
  "payment_type": "danamon_online",
  "transaction_time": "2016-06-19 18:41:25",
  "transaction_status": "expire",
  "fraud_status": "accept",
  "signature_key": "3f1ddaf45b269df7a1638d6d4080957e1323df2cbc2da83549f86a23b17c2acae0215994bb60805455daf157125990414259e5319e84c9288fd6222e655c6756"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of DOB transaction, the possible value is pending
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
redirect_url	String	Redirect URL to DOB payment page

E-wallet

One of the payment method offered by Midtrans is e-Wallet. By using this e-Wallet, customer will have an option to make a payment via e-Wallet and Midtrans will send real time notification when the customer complete the payment.

At this moment, Midtrans has integrated with 4 different e-Wallet payment methods:

• GoPay

GoPay

GoPay Charge

{
  "payment_type": "gopay",
  "transaction_details": {
    "order_id": "order03",
    "gross_amount": 275000
  },
  "item_details": [
    {
      "id": "id1",
      "price": 275000,
      "quantity": 1,
      "name": "Bluedio H+ Turbine Headphone with Bluetooth 4.1 -"
    }
  ],
  "customer_details": {
    "first_name": "Budi",
    "last_name": "Utomo",
    "email": "budi.utomo@midtrans.com",
    "phone": "081223323423"
  },
  "gopay": {
    "enable_callback": true,
    "callback_url": "someapps://callback"
  }
}

GoPay is an e-Wallet payment method by GoJek. Users will pay using the GoJek app. The user flow varies when using a web browser (on a computer or a tablet) compared to a SmartPhone:

1. QR Code - This is the user flow on a web browser (on a computer or a tablet). User is shown a QR code and asked to scan using the GoJek app. (Diagram 1)
2. Deeplink - This is the user flow on a SmartPhone/mobile device. User gets redirected to the GoJek app to finish payment. (Diagram 2)

Diagram 1	Diagram 2

Integration steps:

1. Create payment instructions for users (see example below)
2. Merchant sends request to Midtrans
3. Alter payment flow depending on the device used:
   • Show QR code image (on a computer or a tablet)
   • Create redirect link to GoJek app (on SmartPhone/mobile device)
4. Handle notifications

Instruction Example
For QR Code Tap Pay using GoPay QR code will appear on the next page Open GoJek app on your mobile phone Tap Pay then scan the QR Code Check and verify your payment details then tap PAY Enter your security PIN Your transaction is finished
For Deeplink Tap Pay using GoPay You will be redirected to GoJek app Check and verify your payment details then tap Pay Enter your security PIN Your transaction is finished

Following attributes are required to charge GoPay:

JSON Attribute	Type	Description
payment_type	String	Set GoPay payment method. Value: gopay
transaction_details	Object	Transaction details
item_details	Object	Shopping item details
customer_details	Object	Customer details
gopay	Object	Charge details using GoPay

GoPay Charge Response and Notifications

GoPay Charge Response

{
    "status_code": "201",
    "status_message": "GO-PAY billing created",
    "transaction_id": "e48447d1-cfa9-4b02-b163-2e915d4417ac",
    "order_id": "SAMPLE-ORDER-ID-01",
    "gross_amount": "10000.00",
    "payment_type": "gopay",
    "transaction_time": "2017-10-04 12:00:00",
    "transaction_status": "pending",
    "actions": [{
            "name": "generate-qr-code",
            "method": "GET",
            "url": "https://api.midtrans.com/v2/gopay/e48447d1-cfa9-4b02-b163-2e915d4417ac/qr-code"
        },
    {
            "name": "deeplink-redirect",
            "method": "GET",
            "url": "gojek://gopay/merchanttransfer?tref=1509110800474199656LMVO&amount=10000&activity=GP:RR&callback_url=someapps://callback?order_id=SAMPLE-ORDER-ID-01"
        },
        {
            "name": "get-status",
            "method": "GET",
            "url": "https://api.midtrans.com/v2/e48447d1-cfa9-4b02-b163-2e915d4417ac/status"
        },
        {
            "name": "cancel",
            "method": "POST",
            "url": "https://api.midtrans.com/v2/e48447d1-cfa9-4b02-b163-2e915d4417ac/cancel",
            "fields": []
        }
    ],
    "channel_response_code": "200",
    "channel_response_message": "Success",
  "currency": "IDR"
}

GoPay Pending notification

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "1c28dbbb-8596-48e4-85d7-9f1382db8a1f",
  "order_id": "order03",
  "gross_amount": "275000.00",
  "payment_type": "gopay",
  "transaction_time": "2016-06-19 15:50:12",
  "transaction_status": "pending",
  "signature_key": "40747f7f8f489c423c8ed72879ca8cb28dcd0c03fc9a192138667c4588f91486ae46094a6695d9fddbce0abab8055fd483b65ecf59e3c43d4a22cc024326993a"
}

GoPay Settlement notification

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "1c28dbbb-8596-48e4-85d7-9f1382db8a1f",
  "order_id": "order03",
  "gross_amount": "275000.00",
  "payment_type": "gopay",
  "transaction_time": "2016-06-19 15:54:42",
  "transaction_status": "settlement",
  "signature_key": "973d175e6368ad844b5817882489e6b22934d796a41a0573c066b1e64532dc0001087b87d877a3eac37cba20a733e1305f5e62739e65ff501d5d33c5ac62530f"
}

GoPay Expired notification

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "1c28dbbb-8596-48e4-85d7-9f1382db8a1f",
  "order_id": "order03",
  "gross_amount": "275000.00",
  "payment_type": "gopay",
  "transaction_time": "2016-06-20 15:50:12",
  "transaction_status": "expire",
  "signature_key": "53c6e2e3639a6b5c09b9103aa343f00cfd0168c6a69a2d4f2203bdc58072531ad7b340ea01725538996a7827c4ce091fb94d0aa70778a20c69d3f9991e0f65eb"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of GoPay transaction, the possible value is pending, settlement, expire, deny
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
actions	Array(Object)	Actions which can be performed which this transaction. Use generate-qr-code action to render the QR code image (PNG format). Use deeplink-redirect action to redirect to GO-JEK apps.
channel_response_code	String	Response code from payment channel provider
channel_response_message	String	Response message from payment channel provider

Implementing GoPay Deeplink Callback

In addition to the standard mobile apps flow, e-commerce may opt to implement a deeplink callback to redirect customer back from GO-JEK to their apps.

Pre-requisites: E-commerce needs to prepare a deeplink which accept two query parameters

Query Parameter	Type	Description
order_id	String	Order ID sent on the Charge Request.
result	String	Result of the transaction to decide what kind of page to show to customer. Possible values: success or failure.

WARNING: It is highly recommended to avoid using value passed on result to update status on backend. There is HTTP notification for this use case.

Integration steps (Please look to the side for sample implementation):

1. Set enable_callback parameter in the charge request to true.
2. Set callback_url with the deeplink url to e-commerce apps.
3. Handle redirection with above parameters.

Over the Counter

Over the counter payment method allows the customer to pay online transaction over the store counter. At this moment, Midtrans has integrated with 2 different counters:

• Indomaret
• Alfamart (New)

Indomaret

NOTE: There may be cases where SETTLEMENT turns into DENY. It is caused by a reversal triggered by the corresponding payment provider. It may happen in the span of 1 minute.

{
  "payment_type": "cstore",
  "transaction_details": {
    "gross_amount": 162500,
    "order_id": "order04"
  },
  "cstore": {
    "store": "Indomaret",
    "message": "Tiket1 transaction"
  },
  "customer_details": {
    "first_name": "Budi",
    "last_name": "Utomo",
    "email": "budi.utomo@midtrans.com",
    "phone": "0811223344"
  },
  "item_details": [
    {
      "id": "id1",
      "price": 162500,
      "quantity": 1,
      "name": "tiket1"
    }
  ]
}

Indomaret is a feature provided by Indomaret where the customer can make online payment at an Indomaret store. The customer only has to come to Indomaret cashier to complete the payment. By using this over the counter channel, customer can pay their bill at any indomaret store. Midtrans will send a notification in real time for every incoming payment.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Display the payment code to the customer.
3. Handle notification.

Following attributes are required to charge Indomaret:

JSON Attribute	Type	Description
payment_type	String	Set Over the Counter payment method. Value: cstore
transaction_details	Object	Transaction details
cstore	Object	Charge details using Over the Counter
item_details	Object	Shopping item details
customer_details	Object	Customer Details

Indomaret Charge Response and Notification

Indomaret Charge Response

{
  "status_code": "201",
  "status_message": "Success, cstore transaction is successful",
  "transaction_id": "e3f0b1b5-1941-4ffb-9083-4ee5a96d878a",
  "order_id": "order04",
  "gross_amount": "162500.00",
  "payment_type": "cstore",
  "transaction_time": "2016-06-19 17:18:07",
  "transaction_status": "pending",
  "payment_code": "25709650945026"
}

Indomaret Pending Notifications

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "e3f0b1b5-1941-4ffb-9083-4ee5a96d878a",
  "order_id": "order04",
  "gross_amount": "162500.00",
  "payment_type": "cstore",
  "transaction_time": "2016-06-19 17:18:07",
  "transaction_status": "pending",
  "signature_key": "2d488c1ff0adc2396ee9b9765807b6d53182a0aa17cd9bb251b99879099d4f727903a75440b1814539f565774f7a80de0a7336c81d2071b4d3efe92f15400e41",
  "payment_code": "25709650945026",
  "store": "indomaret"
}

Indomaret Settlement Notifications

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "991af93c-1049-4973-b38f-d6052c72e367",
  "order_id": "order04",
  "gross_amount": "162500.00",
  "payment_type": "cstore",
  "transaction_time": "2016-06-20 11:44:07",
  "transaction_status": "settlement",
  "approval_code": "59061607081045705101",
  "signature_key": "a198f93ac43cf98171dcb4bd0323c7e3afbee77a162a09e2381f0a218c761a4ef0254d7650602971735c486fea2e8e9c6d41ee65d6a53d65a12fb1c824e86f9f",
  "payment_code": "25709650945026",
  "store": "indomaret"
}

Indomaret Expired Notifications

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "fd70880f-3458-4b16-9f09-289924185977",
  "order_id": "order04",
  "gross_amount": "162500.00",
  "payment_type": "cstore",
  "transaction_time": "2016-06-20 17:18:08",
  "transaction_status": "expire",
  "signature_key": "c260504a448018b4c4831b381f8a8c5088c37f2706dcc60b4d7d99a16e0ae3c22bc8945cb5177742386bab1ddb12e7c175e1f57686b488e215406fa40fc75481",
  "payment_code": "25709650945026",
  "store": "indomaret"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of Indomaret transaction, the possible value is pending
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
payment_code	String	Unique payment code for customer to complete the payment in Indomaret
store	String	Convenience store identifier

Alfamart

{
  "payment_type": "cstore",
  "transaction_details": {
    "gross_amount": 162500,
    "order_id": "order05"
  },
  "cstore": {
    "store": "alfamart",
    "alfamart_free_text_1": "1st row of receipt,",
    "alfamart_free_text_2": "This is the 2nd row,",
    "alfamart_free_text_3": "3rd row. The end."
  },
  "customer_details": {
    "first_name": "Budi",
    "last_name": "Utomo",
    "email": "budi.utomo@midtrans.com",
    "phone": "0811223344"
  },
  "item_details": [
    {
      "id": "id1",
      "price": 162500,
      "quantity": 1,
      "name": "tiket2"
    }
  ]
}

Alfamart provided customer to make online payment at various store under Alfa group. The supported stores are: Alfamart, Alfamidi, DAN+DAN, and Lawson (Coming soon). The customer needs to visit the cashier of one of the store to continue their payment. Midtrans will send a notification in real time for every incoming payment.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Display the payment code to the customer.
3. Handle notification.

Following attributes are required to charge Alfamart:

JSON Attribute	Type	Description
payment_type	String	Set Over the Counter payment method. Value: cstore
transaction_details	Object	Transaction details
cstore	Object	Charge details using Over the Counter
item_details	Object	Shopping item details
customer_details	Object	Customer Details

Alfamart Charge Response and Notifications

Alfamart Charge Response

{
    "status_code": "201",
    "status_message": "Success, cstore transaction is successful",
    "transaction_id": "f1d381f8-7519-4139-b28f-81c6b3dc38ea",
    "order_id": "order05",
    "gross_amount": "10500.00",
    "payment_type": "cstore",
    "transaction_time": "2016-06-28 16:22:49",
    "transaction_status": "pending",
    "fraud_status": "accept",
    "payment_code": "010811223344",
    "store": "alfamart"
}

Alfamart Pending Notifications

{
  "status_code": "201",
  "status_message": "midtrans payment notification",
  "transaction_id": "e3f0b1b5-1941-4ffb-9083-4ee5a96d878a",
  "order_id": "order04",
  "gross_amount": "162500.00",
  "payment_type": "cstore",
  "transaction_time": "2016-06-19 17:18:07",
  "transaction_status": "pending",
  "signature_key": "2d488c1ff0adc2396ee9b9765807b6d53182a0aa17cd9bb251b99879099d4f727903a75440b1814539f565774f7a80de0a7336c81d2071b4d3efe92f15400e41",
  "payment_code": "25709650945026",
  "store": "alfamart"
}

Alfamart Settlement Notifications

{
  "status_code": "200",
  "status_message": "midtrans payment notification",
  "transaction_id": "991af93c-1049-4973-b38f-d6052c72e367",
  "order_id": "order04",
  "gross_amount": "162500.00",
  "payment_type": "cstore",
  "transaction_time": "2016-06-20 11:44:07",
  "transaction_status": "settlement",
  "approval_code": "59061607081045705101",
  "signature_key": "a198f93ac43cf98171dcb4bd0323c7e3afbee77a162a09e2381f0a218c761a4ef0254d7650602971735c486fea2e8e9c6d41ee65d6a53d65a12fb1c824e86f9f",
  "payment_code": "25709650945026",
  "store": "alfamart"
}

Alfamart Expired Notifications

{
  "status_code": "202",
  "status_message": "midtrans payment notification",
  "transaction_id": "fd70880f-3458-4b16-9f09-289924185977",
  "order_id": "order04",
  "gross_amount": "162500.00",
  "payment_type": "cstore",
  "transaction_time": "2016-06-20 17:18:08",
  "transaction_status": "expire",
  "signature_key": "c260504a448018b4c4831b381f8a8c5088c37f2706dcc60b4d7d99a16e0ae3c22bc8945cb5177742386bab1ddb12e7c175e1f57686b488e215406fa40fc75481",
  "payment_code": "25709650945026",
  "store": "alfamart"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of Indomaret transaction, the possible value is pending
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
payment_code	String	Unique payment code for customer to complete the payment in Alfamart
store	String	Convenience store identifier

Cardless Credit

Cardless credit allows customers to enroll in an affordable monthly payment plan so they don't have to pay all at once. It provides e-commerce access to target certain customer market which lack credit cards but prefer installment. At this moment, Midtrans has integrated to these cardless credits:

• Akulaku

Akulaku

Akulaku Charge

{
  "payment_type": "akulaku",
  "transaction_details": {
    "order_id": "orderid-01",
    "gross_amount": 11000
  },
  "item_details": [
    {
      "id": "1",
      "price": 11000,
      "quantity": 1,
      "name": "Sepatu "
    }
  ],
  "customer_details":{
    "first_name": "John",
    "last_name": "Baker",
    "email": "john.baker@email.com",
    "phone": "08123456789"
  }
}

In addition to their shopping mall business, Akulaku has been enabling e-commerces to sell their merchandise in installment. It allows their customers to pay in installment without credit card as long as they are registered to Akulaku.

Integration steps:

1. Merchant send charge request to Midtrans.
2. Do redirection to address specified in the response.
3. Handle notification.

Following attributes are required to charge Akulaku:

JSON Attribute	Type	Description
payment_type	String	Set Akulaku payment method. Value: akulaku
transaction_details	Object	Details of the transaction will be paid by customer
item_details	Object	Shopping item details *Required for Akulaku
customer_details	Object	Customer Details

Akulaku Charge Response and notification

Akulaku Charge Response

{
    "status_code": "201",
    "status_message": "Success, Akulaku transaction is created",
    "transaction_id": "b3a40398-d95d-4bb9-afe8-9a57bc0786ea",
    "order_id": "orderid-01",
    "redirect_url": "https://api.sandbox.veritrans.co.id/v2/akulaku/redirect/b3a40398-d95d-4bb9-afe8-9a57bc0786ea",
    "gross_amount": "11000.00",
    "currency": "IDR",
    "payment_type": "akulaku",
    "transaction_time": "2018-08-24 16:20:36",
    "transaction_status": "pending",
    "fraud_status": "accept",
    "channel_response_code": "",
    "channel_response_message": ""
}

Akulaku Pending notification

{
  "transaction_time": "2018-08-24 16:20:36",
  "gross_amount": "11000.00",
  "order_id": "orderid-01",
  "payment_type": "akulaku",
  "signature_key": "e47d73b2a10347d291e85a7c39c5fa2a7b760f0af7d9882f9c1b26db06e1af948968184b78f67112158cdeddd2141fe41068fdb37361ce11c3d2509354224a80",
  "status_code": "201",
  "transaction_id": "b3a40398-d95d-4bb9-afe8-9a57bc0786ea",
  "transaction_status": "pending",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

Akulaku Settlement notification

{
  "transaction_time": "2018-08-24 16:20:36",
  "gross_amount": "11000.00",
  "order_id": "orderid-01",
  "payment_type": "akulaku",
  "signature_key": "35c4111539e184b268b7c1cd62a9c254e5d27c992c8fd55084f930b69b09eaafcfe14b0d512c697648295fdb45de777e1316b401f4729846a91b3de88cde3f05",
  "status_code": "200",
  "transaction_id": "b3a40398-d95d-4bb9-afe8-9a57bc0786ea",
  "transaction_status": "settlement",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

Akulaku Expired notification

{
  "transaction_time": "2018-08-24 16:20:36",
  "gross_amount": "11000.00",
  "order_id": "orderid-01",
  "payment_type": "akulaku",
  "signature_key": "62a8c432bb5a288a0495dd4f868b0aede4535e0c8a9fbebb3c6e9d4ea0db6f1963e551e70a99e80512030afa5ba8268f9be7b17b13a422ebef4620988c55d5ed",
  "status_code": "202",
  "transaction_id": "b3a40398-d95d-4bb9-afe8-9a57bc0786ea",
  "transaction_status": "expire",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

Akulaku Deny notification

{
  "transaction_time": "2018-08-24 16:20:36",
  "gross_amount": "11000.00",
  "order_id": "orderid-01",
  "payment_type": "akulaku",
  "signature_key": "c2bdfd8d1b25100f5512b2573ecad8f2d324837a731362491b5a6b0bbd7ec74a032010754129f4c74f77a21796f747258ea611a3d5710648f63342570cdd0bb4",
  "status_code": "202",
  "transaction_id": "b3a40398-d95d-4bb9-afe8-9a57bc0786ea",
  "transaction_status": "deny",
  "fraud_status": "accept",
  "status_message": "midtrans payment notification"
}

JSON Attribute	Type	Description
transaction_id	String	Transaction ID given by Midtrans
order_id	String	Order ID given by merchant
gross_amount	String	Total amount of transaction
payment_type	String	Transaction payment method
transaction_time	String	Timestamp of transaction
transaction_status	String	Transaction status of Akulaku transaction, the possible value is pending or deny
fraud_status	String	Detection result by Fraud Detection System (FDS). Possible Value: accept : Approved by FDS. challenge: Questioned by FDS. NOTE: Approve transaction to accept it or transaction will auto cancel during settlement. deny: Denied by FDS. Transaction automatically failed
status_code	String	Status code of transaction charge result
status_message	String	Description of transaction charge result
redirect_url	String	Redirect URL to Akulaku payment page

Handing Notifications

Receiving Notifications

Signature key logic

SHA512(order_id+status_code+gross_amount+serverkey)

Sample code generate signature key

  <?php
  $orderId = "1111";
  $statusCode = "200";
  $grossAmount = "100000.00";
  $serverKey = "askvnoibnosifnboseofinbofinfgbiufglnbfg";
  $input = $orderId.$statusCode.$grossAmount.$serverKey;
  $signature = openssl_digest($input, 'sha512');
  echo "INPUT: " , $input."<br/>";
  echo "SIGNATURE: " , $signature;
  ?>

In order to increase the security aspect, there are several ways to ensure the notification is received from Midtrans.

Challenge Response

An additional mechanism we provide to verify the content and the origin of the notification is to challenge. This can be achieved by calling the get status API. The response is the same as the notification status.

Signature Key

We added a signature key information in our notification. The purpose of this signature key is to validate whether the notification is originated from Midtrans or not. Should the notification not be genuine, merchants can disregard the notification. Please find on the side, the logic of the signature key and the sample code to generate signature key.

Best Practice to Handle notification

• Always use an HTTPS endpoint. It is secure and there cannot be MITM attacks because we validate the certificates match the hosts. Also do not use self signed certificates.
• Use standard port (80/443) for notification callback url
• Always implement notification in an idempotent way, in extremely rare cases, we may send multiple notifications for the same transaction event twice. It should not cause double entries in the merchant end, The simple way of achieving this is to use orderid as the key to track the entries.
• Always check the signature hash of the notification, This will confirm that the notification was actually sent by Midtrans, because we encode the shared secret (server key). Nobody else can build this signature hash.
• Always check all the following three fields for confirming success transaction
  • status code: Should be 200 for successful transactions
  • fraud status: ACCEPT
  • transaction status : settlement/capture
• We strive to send the notification immediately after the transaction has occurred, but in extremely rare cases, it may be delayed because of transaction spikes. If you have not received a notification, please use the Status API to check for current status of the transaction.
• It is safe to call Status API to get the latest status of the transaction/order on each notification.
• We set the HTTP timeout to 15 seconds.
  Please strive to keep the response time of the the HTTP notifications under 5 seconds.
• In extremely rare cases we may send the HTTP notifications out of order, ie. a "settlement" status for a notification before the notification for "Pending" status. It's important that such later notifications are ignored. Here's the state transition diagram that you could use. But again, use our /status API to confirm the actual status.
• We send the notification body as JSON, please parse the JSON with a JSON parser. Always expect new fields will be added to the notification body, so parse it in a non strict format, so if the parser sees new fields, it should not throw exception. It should gracefully ignore the new fields. This allows us to extend our notification system for newer use cases without breaking old clients.
• Always use the right HTTP Status code for responding to the notification, we handle retry for error cases differently based on the status code
  • for 2xx: No retries, it is considered success
  • for 500: Retry only once
  • for 503: Retry 4 times
  • for 400/404: Retry 2 times
  • for 301/302/303: No retries. We suggest the notificaiton endpoint should be update in setting instead of reply these status code.
  • for 307/308: Follow the new url with POST method and same notification body. Max redirect is 5 times
  • for all other failures: Retry 5 times
• We do retry at most 5 times with following policy
  • Different retry interval from 1st time to 5th time (2m, 10m, 30m, 1.5hour, 3.5hour)
  • Put a random time shift for each time retry base on above interval. For example, the first time retry might be 33s(at most 2m) after the job failed.

The following are the standard types of notifications. Note that different types of notifications can be added in addition to the below. Also new fields may be added to the existing notification, please confirm with the latest documentation for the exact fields.

Override Notification Url

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

There are two headers we provide:

1. X-Append-Notification: to add new notification url(s) alongside the settings on dashboard
2. X-Override-Notification: to use new notification url(s) disregarding the settings on dashboard

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

Sample case

Append Notification Sample

curl -X POST \
  https://api.midtrans.com/v2/charge \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic NjJiMTVhN2QtZTVmOC00YjNjLTllYWItY2E4MjdjYTM3ZjU1Og==' \
  -H 'Content-Type: application/json' \
  -H 'X-Append-Notification: https://example.com/test1,https://example.com/test2' \
  -H 'cache-control: no-cache' \
  -d '{
    "payment_type": "gopay",
    "transaction_details": {
        "order_id": "1553229166",
        "gross_amount": 10000
    }
}'

Override Notification Sample

curl -X POST \
  https://api.midtrans.com/v2/charge \
  -H 'Accept: application/json' \
  -H 'Authorization: Basic NjJiMTVhN2QtZTVmOC00YjNjLTllYWItY2E4MjdjYTM3ZjU1Og==' \
  -H 'Content-Type: application/json' \
  -H 'X-Override-Notification: https://example.com/test1,https://example.com/test2' \
  -H 'cache-control: no-cache' \
  -d '{
    "payment_type": "gopay",
    "transaction_details": {
        "order_id": "1553229166",
        "gross_amount": 10000
    }
}'

Assuming merchant has set https://example.com as their notification url on the dashboard.

If they set X-Append-Notification with values https://example.com/test1,https://example.com/test2. Then, every HTTP notification for that specific transaction will be sent to:

1. https://example.com,
2. https://example.com/test1, and
3. https://example.com/test2

Else if they set X-Override-Notification with values https://example.com/test1,https://example.com/test2. Then, every HTTP notification for that specific transaction will be sent to:

1. https://example.com/test1 and
2. https://example.com/test2

Status Code

Status Codes used by Midtrans API are categorized into 2xx, 3xx, 4xx dan 5xx.

Code 2xx

Status	Description
200	Credit Card: Success. Request is successful, and transaction is authorize, capture, settlement, cancel, approve challenge transactions, accepted by Midtrans and bank. Other payment methods: Success. The transaction is settlement, cancel
201	Credit Card: Challenge. The transaction successfully sent to bank but the process has not been completed, need manual action from merchant to complete the transaction process. If the merchant does not perform any action until settlement time (H+1 16:00) Midtrans will cancel the transaction. Bank Transfer: Pending. The transaction successfully sent to bank but the process has not been completed by the customer. By default, the transaction will expire within 24 hours. GO-PAY Pending. The transaction has successfully created to GO-PAY but has not been completed by the customer. By default, the transaction will expire within 15 minutes. Cimb Clicks: Pending. The transaction successfully sent to bank but the process has not been completed by the customer. By default, the transaction will expire within 2 hours. BRI ePay: Pending. The transaction successfully sent to bank but the process has not been completed by the customer. By default, the transaction will expire within 2 hours. Klik BCA: Pending. The transaction successfully sent to bank but the process has not been completed by the customer. By default, the transaction will expire within 2 hours. BCA Klikpay: Pending. The transaction successfully sent to bank but the process has not been completed by the customer. By default, the transaction will expire within 2 hours. Mandiri Bill Payment: Pending. The transaction successfully sent to bank but the process has not been completed by the customer. By default, the transaction will expire within 2 hours. XL Tunai: Pending. The transaction successfully sent to provider but the process has not been completed by the customer. By default, the transaction will expire within 2 hours. Indomaret: Pending. The transaction successfully sent to provider but the process has not been completed by the customer. By default, the transaction will expire within 2 hours
202	Credit Card: Denied. The transaction has been processed but is denied by payment provider or Midtrans' fraud detection system. Other payment methods: Denied. The transaction has been processed but is denied by payment provider

Code 3xx

Status	Description
300	Move Permanently, current and all future requests should be directed to the new URL

Code 4xx

Status	Description
400	Validation Error, merchant sent bad request data example; validation error, invalid transaction type, invalid credit card format, etc.
401	Access denied due to unauthorized transaction, please check client key or server key
402	Merchant doesn't have access for this payment type
403	The requested resource is only capable of generating content not acceptable according to the accepting headers that sent in the request
404	The requested resource/transaction is not found (eg. order_id is not exist)
405	Http method is not allowed
406	Duplicate order ID. Order ID has already been utilized previously
407	Expired transaction
408	Merchant sent the wrong data type
409	Merchant has sent too many transactions for the same card number
410	Merchant account is deactivated. Please contact Midtrans support
411	Token id is missing, invalid, or timed out
412	Merchant cannot modify status of the transaction
413	The request cannot be processed due to malformed syntax in the request body
414	Refund request is rejected due to invalid amount

Code 5xx

Status	Description
500	Internal Server Error.
501	The feature has not available.
502	Internal Server Error: Bank Connection Problem.
503	Bank/partner is experiencing connection issue.
504	Internal Server Error: Fraud detection is unavailable.
505	The requested payment reference is not available. Either try again to use different one.

Channel Response Code

For some payment channels, we included channnel_response_code and channel_response_message on API response. These are the values.

Credit Card Response Codes

Credit card is divided into two category based on its channel to acquirer: Host-to-Host and MIGS.

Host-to-Host

Included bank: CIMB Niaga, Bank Mandiri, BNI, Bank Mega

Code	Message	Explanation
00	Approved	Transaction was successful.
01	Refer to Issuer	The customer’s bank (Card Issuer) has indicated there is a problem with the credit card number. The customer should contact their bank. The customer should use an alternate credit card.
02	Refer to Issuer, special	The customer’s bank (Card Issuer) has indicated there is a problem with the credit card number. The customer should contact their bank. The customer should use an alternate credit card.
03	No Merchant	The Merchant ID is invalid, you should contact your Bank and ensure you have provided the correct Merchant Account Number.
04	Pick Up Card	The customer’s bank (Card Issuer) has declined the transaction and requested that your customer’s credit card be retained. (card reported lost or stolen). The customer should use an alternate credit card.
05	Do Not Honour	The customer’s bank has declined the transaction as the credit card number has failed a security check, or the funds have been frozen or depleted. The customer should use an alternate credit card.
06	Error	The customer’s bank (Card Issuer) has declined the transaction as there is a problem with the credit card number. The customer should contact their bank. The customer should use an alternate credit card.
07	Pick Up Card, Special	The customer’s bank (Card Issuer) has declined the transaction and requested that your customer’s credit card be retained. (card reported lost or stolen) The customer should use an alternate credit card.
09	Request In Progress	The customer’s bank (Card Issuer) has indicated there is a problem with the credit card number. The customer should contact their bank. The customer should use an alternate credit card.
12	Invalid Transaction	The customer’s bank (Card Issuer) has declined the transaction because of an invalid format or field. Check the transaction information and try processing the transaction again.
13	Invalid Amount	An invalid character (e.g. a amount sign or a space) may be being passed to the gateway. Check your website’s code.
14	Invalid Card Number	The customer’s bank (Card Issuer) has declined the transaction as the Credit Card number does not exist. Check the credit card information and try processing the transaction again.
15	No Issuer	The customer’s bank (Card Issuer) does not exist. Check the credit card information and try processing the transaction again.
19	Re-enter Last Transaction	The transaction has not been processed and the customer should attempt to process the transaction again.
21	No Action Taken	The customer’s bank (Card Issuer) has indicated there is a problem with the credit card number. The customer should contact their bank. The customer should use an alternate credit card.
22	Suspected Malfunction	The customer’s bank (Card Issuer) cannot be contacted during the transaction. The customer should check the credit card information and try processing the transaction again.
23	Unacceptable Transaction Fee	An unspecified error has occurred.
25	Unable to Locate Record On File	The customer’s bank (Card Issuer) does not recognise the credit card details. The customer should check the credit card information and try processing the transaction again.
30	Format Error	The customer’s bank (Card Issuer) does not recognise the transaction details. The customer should check the transaction information and try processing the transaction again.
31	Bank Not Supported By Switch	The customer’s bank (Card Issuer) has declined the transaction as it does not allow transactions originating through mail / telephone, fax, email or Internet orders. This error is associated customers attempting to use a Discover Card. The customer should use an alternate credit card.
33	Expired Card, Capture	The customer’s bank (Card Issuer) has declined the transaction as Credit Card has expired or the date is incorrect. Check the expiry date in the transaction and try processing the transaction again.
34	Suspected Fraud, Retain Card	The customer’s bank (Card Issuer) has declined the transaction as there is a suspected fraud on this Credit Card number.
35	Card Acceptor, Contact Acquirer, Retain Card	The customer’s bank (Card Issuer) has declined the transaction and requested that the customer’s credit card be retained (card reported lost or stolen). The customer should use an alternate credit card.
36	Restricted Card, Retain Card	The customer’s bank (Card Issuer) has declined the transaction and requested that the customer’s credit card be retained. (card reported lost or stolen) The customer should use an alternate credit card.
37	Contact Acquirer Security Department, Retain Card	The customer’s bank (Card Issuer) has declined the transaction and requested that your customer’s credit card be retained. (card reported lost or stolen) The customer should use an alternate credit card.
38	PIN Tries Exceeded, Capture	The customer’s bank (Card Issuer) has declined the transaction as the customer has entered the incorrect PIN three times. The customer’s bank (Card Issuer) has requested you retain the credit card. The customer should use an alternate credit card and contact their bank.
39	No Credit Account	The customer’s bank has declined the transaction as the Credit Card number used is not a credit account. The customer should use an alternate credit card.
40	Function Not Supported	The customer’s bank (Card Issuer) has declined the transaction as it does not allow this type of transaction. The customer should use an alternate credit card.
41	Lost Card	The customer’s bank (Card Issuer) has declined the transaction as the card has been reported lost. The customer should use an alternate credit card.
42	No Universal Account	The customer’s bank (Card Issuer) has declined the transaction as the account type selected is not valid for this credit card number. The customer should use an alternate credit card.
43	Stolen Card	The customer’s bank (Card Issuer) has declined the transaction as the card has been reported stolen. The customer should use an alternate credit card.
44	No Investment Account	The customer’s bank (Card Issuer) has declined the transaction as the account type selected is not valid for this credit card number. The customer should use an alternate credit card.
51	Insufficient Funds	The customer’s bank (Card Issuer) has declined the transaction as the credit card does not have sufficient funds. The customer should use an alternate credit card.
52	No Cheque Account	The customer’s bank (Card Issuer) has declined the transaction as the credit card number is associated to a cheque account that does not exist. The customer should use an alternate credit card.
53	No Savings Account	The customer’s bank (Card Issuer) has declined the transaction as the credit card number is associated to a savings account that does not exist. The customer should use an alternate credit card.
54	Expired Card	The customer’s bank (Card Issuer) has declined the transaction as the credit card appears to have expired. The customer should check the expiry date entered and try again, or use an alternate credit card.
55	Incorrect PIN	The customer’s bank (Card Issuer) has declined the transaction as the customer has entered an incorrect PIN. The customer should re-enter their PIN, otherwise use an alternate credit card.
56	No Card Record	The Customer’s bank has declined the transaction as the credit card number does not exist. The customer should use an alternate credit card.
57	Function Not Permitted to Cardholder	The Customer’s bank has declined the transaction as this credit card cannot be used for this type of transaction. The customer should use an alternate credit card.
58	Function Not Permitted to Terminal	The Customer’s bank has declined the transaction as this credit card cannot be used for this type of transaction. This may be associated with a test credit card number. The customer should use an alternate credit card.
59	Suspected Fraud	The customer’s bank has declined this transaction as the credit card appears to be fraudulent.
60	Acceptor Contact Acquirer	The customer’s bank (card issuer) has declined the transaction. The customer should contact their bank and retry the transaction.
61	Exceeds Withdrawal Limit	The customer’s bank has declined the transaction as it will exceed the customer’s card limit. The customer should use an alternate credit card.
62	Restricted Card	The customer’s bank has declined the transaction as the credit card has some restrictions. The customer should use an alternate credit card.
63	Security Violation	The customer’s bank has declined the transaction. The customer should use an alternate credit card.
64	Original Amount Incorrect	The customer’s bank has declined the transaction due to the amount attempting to be processed. The customer should check the transaction amount and try again.
66	Acceptor Contact Acquirer, Security	The customer’s bank has declined the transaction and request the Merchant to contact the bank. The customer should use an alternate credit card.
67	Capture Card	The customer’s bank has declined the transaction as the card is suspected to be counterfeit. The customer’s bank (Card Issuer) has requested that your customer’s credit card be retained. The customer should use an alternate credit card.
75	PIN Tries Exceeded	The customer’s bank has declined the transaction as the customer has entered the incorrect PIN more than three times. The customer should use an alternate credit card.
82	CVV Validation Error	The customer’s bank has declined the transaction as the CVV is incorrect. The customer should check the CVV details and try again. If not successful, the customer should use an alternate credit card.
90	Cutoff In Progress	The customer’s bank is temporarily not able to process this customer’s credit card. The customer should attempt to process this transaction again.
91	Card Issuer Unavailable	The customer’s bank is unable to be contacted to authorise the transaction. The customer should attempt to process this transaction again.
92	Unable To Route Transaction	The customer’s bank cannot be found for routing. This response code is often returned when the customer is using a test credit card number. The customer should attempt to process this transaction again.
93	Cannot Complete, Violation Of The Law	The customer’s bank has declined the transaction and request the customer to contact their bank. The customer should use an alternate credit card.
94	Duplicate Transaction	The customer’s bank has declined the transaction as this transaction appears to be a duplicate transmission. No action required.
96	System Error	The customer’s bank was not able to process the transaction. The customer should attempt to process this transaction again.
N0	CSC not provided - credit transaction is not allowed	Transaction failed. Customers should try using another card.
N7	Decline for CVV2 failure (for Visa cards only)	The customer’s bank has declined the transaction as the CVV is incorrect. The customer should check the CVV details and try again. If not successful, the customer should use an alternate credit card.
Q5	Already settled - can't settle twice in a day	Transaction has been settled, hence cannot be settled anymore.
Z2	The transaction has already been reversed	Transaction has been reversed, hence cannot be reversed anymore.
Z3	Transaction amount is greater than authorised	The customer's bank has declined the capture transaction since amount greater than the authorised amount. The customer should use an alternate credit card.

MIGS

Included bank: BCA, BRI, Maybank

Code	Message	Explanation
0	Transaction Successful	Transaction was successful.
?	Response Unknown	Need to check directly with Acquiring Bank.
1	Transaction could not be processed	There is an issue with merchant's account or the ID/Access Code the merchant uses is incorrect.
2	Transaction Declined – Contact Issuing Bank	The customer should contact their bank. The customer should use an alternate credit card.
3	Declined – No reply from Bank	The customer should use an alternate credit card.
4	Transaction Declined – Expired Card	The customer’s bank (Card Issuer) has declined the transaction as Credit Card has expired or the date is incorrect. Check the expiry date in the transaction and try processing the transaction again.
5	Transaction Declined – Insufficient credit	The customer’s bank (Card Issuer) has declined the transaction as the credit card does not have sufficient funds. The customer should use an alternate credit card.
6	Transaction Declined – Bank system error	The customer's bank/ acquiring bank experienced a system error.
7	Payment Server Processing Error	Typically caused by invalid input data such as an invalid credit card number. Processing errors can also occur. The customer should check the credit card information and try processing the transaction again.
8	Transaction Declined – Transaction Type Not Supported	The customer’s bank (Card Issuer) has declined the transaction as it does not allow this type of transaction. The customer should use an alternate credit card.
9	Bank Declined Transaction (Do not contact Bank)	The customer should use an alternate credit card. Can be caused by following reasons: Transaction Aborted (A) Transaction Blocked (B) Transaction Cancelled (C) Deferred Transaction (D) Transaction Declined – Refer to card issuer (E) Authentication Failed (F) Card Security Code Failed (I) Shopping Transaction Locked - This indicates that there is another transaction taking place using the same shopping transaction number (L) Cardholder is not enrolled in 3D Secure - Authentication Only (N) Transaction is Pending (P) Retry Limits Exceeded, Transaction Not Processed (R) Card Security Code Failed (U)

GO-PAY Response Codes

Code	Message	Explanation
900	GENERIC_SERVICE_ERROR	Intermittent service error. For the most case, it is retriable.
901	ATTRIBUTE_NOT_AVAILABLE_ERROR	Internal System Error.
902	MALFORMED_JSON	Internal System Error.
903	FORBIDDEN_OPERATION	Internal System Error.
101	WALLET_NOT_FOUND	Internal System Error.
102	MERCHANT_NOT_AUTHORIZED	Internal System Error.
103	ILLEGAL_KYC_TYPE	Internal System Error.
104	ILLEGAL_USER_TYPE	Internal System Error.
105	USER_NOT_FOUND	Internal System Error.
106	RESERVATION_NOT_FOUND	Internal System Error.
107	VOUCHER_BATCH_NOT_FOUND	Internal System Error.
108	SPONSOR_NOT_FOUND	Internal System Error.
109	CURRENTLY_NOT_ALLOWED	Internal System Error.
110	UNAUTHORIZED	Internal System Error.
111	PIN_ALREADY_SETUP	Internal System Error.
112	WALLET_BLOCKED	Internal System Error.
113	INVALID_PIN_FORMAT	Internal System Error.
114	PHONE_NUMBER_NOT_FOUND	Internal System Error.
115	WALLET_PHONE_NUMBER_NOT_MATCHED	Internal System Error.
116	MERCHANT_NOT_FOUND	Internal System Error.
117	KYC_NOT_AVAILABLE	Internal System Error.
118	WALLET_RULESET_NOT_FOUND	Internal System Error.
119	INCORRECT_PIN	Internal System Error.
120	PIN_NOT_SETUP	Internal System Error.
121	NEW_PIN_SAME_AS_OLD_PIN	Internal System Error.
122	ILLEGAL_RECEIVER	Internal System Error.
123	KYC_NOT_APPROVED	Internal System Error.
124	KYC_PENDING	Internal System Error.
125	PIN_IS_REQUIRED	Internal System Error.
126	CUSTOMER_WALLET_BLOCKED	Internal System Error.
127	SERVICE_PROVIDER_WALLET_BLOCKED	Internal System Error.
128	LEDGER_WALLET_NOT_FOUND	Internal System Error.
129	WALLET_ALREADY_EXISTS	Internal System Error.
130	SERVICE_BLOCKED	Internal System Error.
131	LINKED_WALLET_NOT_FOUND	Internal System Error.
132	TRANSACTION_IN_PROGRESS	Internal System Error.
133	SETTLEMENT_FAILED	Internal System Error.
134	MERCHANT_INFORMATION_CACHE_STORE_FAILED	Internal System Error.
135	TRANSACTION_NOT_FOUND	Internal System Error.
142	INVALID_MERCHANT_IDENTIFIER	Internal System Error.
151	AMEND_RESERVATION_INVALID_AMOUNT	Internal System Error.
000	AUTHORIZATION_REQUIRED	Internal System Error.
001	REQUEST_ID_REQUIRED	Internal System Error.
201	NOT_ENOUGH_BALANCE	Internal System Error.
202	EXCESSIVE_BALANCE	Refund failed because customer balance exceeds their upper limit.
203	RESERVATION_REDEEMED	Internal System Error.
204	RESERVATION_EXPIRED	Internal System Error.
205	ZERO_PAGE_SIZE	Internal System Error.
206	DUPLICATE_RESERVATION	Internal System Error.
207	RESERVATION_PROCESSED	Internal System Error.
208	INVALID_POINTS_RESERVATION	Internal System Error.
209	INVALID_RESERVATION_AMOUNT	Internal System Error.
210	RESERVATION_AMOUNT_DOES_NOT_MATCH_PAYMENT	Internal System Error.
211	WALLET_BALANCE_LIMIT_VIOLATED	Internal System Error.
212	INVALID_MDR	Internal System Error.
213	MONTHLY_WALLET_BALANCE_LIMIT_EXCEEDED	Internal System Error.
214	RESERVATION_CANCELLED	Internal System Error.
215	RECEIVER_MAX_WALLET_BALANCE_LIMIT_EXCEEDED	Internal System Error.
216	RECEIVER_MONTHLY_WALLET_BALANCE_LIMIT_EXCEEDED	Internal System Error.
301	MALFORMED_PHONE_NUMBER	Internal System Error.
302	MISMATCHING_PASSWORD_AND_CONFIRMATION	Internal System Error.
303	FIELD_CANNOT_BE_BLANK	Internal System Error.
304	MALFORMED_EMAIL_ADDRESS	Internal System Error.
305	ILLEGAL_LENGTH_FOR_FIELD	Internal System Error.
307	ILLEGAL_SERVICE_PROVIDER_TYPE	Internal System Error.
308	PHONE_NUMBER_ALREADY_TAKEN	Internal System Error.
309	ACTIVE_WALLET_ALREADY_ASSOCIATED_WITH_PHONE_NUMBER	Internal System Error.
310	MALFORMED_DATA	Internal System Error.
501	MALFORMED_TRANSACTION	Internal System Error.
502	MALFORMED_TRANSACTION_REQUEST	Internal System Error.
503	JOURNAL_LOG_NOT_FOUND	Internal System Error.
601	VOUCHER_NOT_FOUND	Internal System Error.
602	VOUCHER_EXPIRED	Internal System Error.
603	VOUCHER_REDEEMED	Internal System Error.
604	VOUCHER_DISABLED	Internal System Error.
605	VOUCHER_NOT_YET_AVAILABLE	Internal System Error.
606	VOUCHER_BATCH_INVALID	Internal System Error.
607	MALFORMED_POINTS_VOUCHER_TRANSACTION_REQUEST	Internal System Error.
608	VOUCHER_NOT_ALLOCATED_TO_WALLET_ID	Internal System Error.
609	VOUCHER_RESERVATION_NOT_FOUND	Internal System Error.
610	VOUCHER_RESERVED	Internal System Error.
611	NOT_ENOUGH_VOUCHERS	Internal System Error.
612	VOUCHER_ALLOCATION_FAILED	Internal System Error.
613	VOUCHER_BATCH_GROUP_NOT_FOUND	Internal System Error.
614	VOUCHER_BATCH_SUPER_GROUP_NOT_FOUND	Internal System Error.
615	VOUCHER_ALLOCATION_RATE_LIMIT_EXCEEDED	Internal System Error.
616	MALFORMED_VOUCHER_BATCHES_REQUEST	Internal System Error.
617	VOUCHER_BATCH_GROUP_INVALID_DUPLICATE_ERROR	Internal System Error.
618	VOUCHER_BATCH_GROUP_INVALID_REQUEST	Internal System Error.
619	VOUCHER_BATCH_GROUP_INVALID_ATTRIBUTE_ERROR	Internal System Error.
620	VOUCHER_BATCH_SUPER_GROUP_INVALID_DUPLICATE_ERROR	Internal System Error.
621	VOUCHER_BATCH_SUPER_GROUP_INVALID_REQUEST	Internal System Error.
622	VOUCHER_REDEMPTION_TIME_RESTRICTED	Internal System Error.
623	INVALID_VOUCHER_BATCH_DATA	Internal System Error.
624	VOUCHER_PICKS_COUNT_EXCEEDED_ERROR	Internal System Error.
625	RESERVED_VOUCHERS_FOR_ALLOCATION_NOT_FOUND	Internal System Error.
626	RESERVE_FOR_ALLOCATION_REFERENCE_ID_NOT_FOUND	Internal System Error.
627	INVALID_VOUCHER_REFUND_REQUEST	Internal System Error.
628	VOUCHER_NOT_AVAILABLE_WITH_POINTS	Internal System Error.
629	VOUCHER_BATCH_NO_LONGER_AVAILABLE	Internal System Error.
701	POINTS_TOKEN_ALLOCATION_ERROR	Internal System Error.
703	POINTS_TOKEN_NOT_ALLOCATED_ERROR	Internal System Error.
704	POINTS_TOKEN_DUPLICATE_JOURNAL_LOG_ID_ERROR	Internal System Error.
705	POINTS_TOKEN_NO_MORE_AVAILABLE_ERROR	Internal System Error.
706	POINTS_TOKEN_UNRECOGNISED_SERVICE_TYPE_ERROR	Internal System Error.
707	POINTS_TOKEN_POINTS_NOT_ENABLED_ERROR	Internal System Error.
708	UNKNOWN_POINTS_TOKEN_TYPE_ERROR	Internal System Error.
709	POINTS_TOKEN_TYPE_DUPLICATE_ERROR	Internal System Error.
710	POINTS_TOKEN_ALLOCATION_RATE_LIMIT_EXCEEDED	Internal System Error.
711	POINTS_TOKEN_TIER_CONFIG_NOT_FOUND	Internal System Error.
712	POINTS_TOKEN_CONFIG_TIER_INVALID_BOUNDARY_ERROR	Internal System Error.
713	POINTS_TOKEN_CONFIG_TIERS_INVALID_RANGE_ERROR	Internal System Error.
714	POINTS_TOKEN_DUPLICATE_TRANSACTION_REFERENCE_ERROR	Internal System Error.
715	POINTS_TOKEN_ALREADY_REDEEMED_ERROR	Internal System Error.
801	DIRECT_DEBIT_TOKEN_NOT_FOUND	Internal System Error.
802	DIRECT_DEBIT_REGISTER_CARD_ERROR	Internal System Error.
803	DIRECT_DEBIT_CARD_NOT_FOUND	Internal System Error.
804	DIRECT_DEBIT_PAYMENT_ERROR	Internal System Error.
805	DIRECT_DEBIT_CARD_ALREADY_REGISTERED	Internal System Error.
806	DIRECT_DEBIT_CARD_DELETE_ERROR	Internal System Error.
807	DIRECT_DEBIT_CARD_EXCEED_LIMIT	Internal System Error.
808	DIRECT_DEBIT_OTP_IS_REQUIRED	Internal System Error.
809	DIRECT_DEBIT_OTP_IS_INVALID	Internal System Error.
810	DIRECT_DEBIT_OTP_RESENT_COUNT_REACHED	Internal System Error.
811	DIRECT_DEBIT_INSUFFICIENT_BALANCE	Internal System Error.
812	DIRECT_DEBIT_CARD_BLOCKED	Internal System Error.
813	DIRECT_DEBIT_TIMEOUT	Internal System Error.
814	DIRECT_DEBIT_INVALID_REQUEST	Internal System Error.
815	DIRECT_DEBIT_UNAUTHORIZED_REQUEST	Internal System Error.
816	DIRECT_DEBIT_MERCHANT_TIMEOUT	Internal System Error.
817	DIRECT_DEBIT_PAYMENT_REJECTED	Internal System Error.
818	DIRECT_DEBIT_REFRESH_CARDS_ERROR	Internal System Error.
819	DIRECT_DEBIT_PAYMENT_NOT_FOUND	Internal System Error.
1101	USER_BANK_ACCOUNT_ALREADY_REGISTERED	Internal System Error.
1102	USER_BANK_ACCOUNT_INVALID_BANK_CODE_OR_SHORT_NAME	Internal System Error.
1103	USER_BANK_ACCOUNT_NOT_FOUND	Internal System Error.
1104	USER_DEFAULT_BANK_ACCOUNT_CANNOT_BE_DEACTIVATED	Internal System Error.
1105	USER_BANK_ACCOUNT_ALREADY_DEACTIVATED	Internal System Error.
1106	USER_GROUP_NOT_DEFINED	Internal System Error.
1201	P2P_RATE_LIMIT_EXCEEDED	Internal System Error.
1202	P2P_PROFILE_RATE_LIMIT_EXCEEDED	Internal System Error.
1203	PIN_RATE_LIMIT_EXCEEDED	Internal System Error.
1301	WALLET_GROUP_NOT_FOUND	Internal System Error.
1302	WALLET_GROUP_ALREADY_EXISTS	Internal System Error.
1303	WALLET_LIMITS_INVALID_VALUE	Internal System Error.
1401	WITHDRAWAL_RATE_LIMIT_EXCEEDED	Internal System Error.
1402	WITHDRAWAL_BATCH_NOT_FOUND	Internal System Error.
1403	WITHDRAWAL_INVALID_FILE_FORMAT	Internal System Error.
1404	WITHDRAWAL_REQUEST_NOT_FOUND	Internal System Error.
1405	WITHDRAWAL_FEATURE_DISABLED	Internal System Error.
1406	WITHDRAWAL_MULTI_REQUEST_FOUND	Internal System Error.
1407	WITHDRAWAL_DAILY_MAXIMUM_REQUEST_LIMIT_EXCEEDED	Internal System Error.
1408	WITHDRAWAL_WEEKLY_MAXIMUM_REQUEST_LIMIT_EXCEEDED	Internal System Error.
1409	WITHDRAWAL_DAILY_MAXIMUM_AMOUNT_LIMIT_EXCEEDED	Internal System Error.
1410	WITHDRAWAL_USER_BANK_NOT_SUPPORTED	Internal System Error.
1411	WITHDRAWAL_AMOUNT_LIMIT_VOILATED	Internal System Error.
1412	WITHDRAWAL_FEATURE_DISABLED_HOLIDAY	Internal System Error.
1413	WITHDRAWAL_FEATURE_DISABLED_BANK_MAINTENANCE	Internal System Error.
1414	WITHDRAWAL_MIN_AMOUNT_LIMIT_VIOLATED	Internal System Error.
1415	WITHDRAWAL_MAX_AMOUNT_LIMIT_VIOLATED	Internal System Error.
1500	KYC_DOCUMENT_NOT_FOUND	Internal System Error.
1501	KYC_ALREADY_APPROVED_OR_REJECTED	Internal System Error.
1503	KYC_APPROVAL_LOG_NOT_FOUND	Internal System Error.
1504	INVALID_KYC_APPROVAL_LEVEL	Internal System Error.
1505	INVALID_KYC_TYPE	Internal System Error.
1601	INVALID_OTP_ACTION	Internal System Error.
1602	OTP_RESENT_COUNT_REACHED	Internal System Error.
1603	OTP_IS_REQUIRED	Internal System Error.
1604	OTP_IS_INVALID	Internal System Error.
1605	OTP_NOT_FOUND_IN_CACHE	Internal System Error.
1606	OTP_DECRYPTION_ERROR	Internal System Error.
1607	INVALID_QR_CODE_DATA	Internal System Error.
1608	QR_CODE_DATA_CHECKSUM_VALIDATION_FAILURE	Internal System Error.
1609	OTP_GENERATE_COUNT_REACHED	Internal System Error.
1610	OTP_EXPIRED	Internal System Error.
1701	MID_NOT_FOUND	Internal System Error.
1702	INVALID_KARTUKU_TRANSACTION_STATE	Internal System Error.
1703	MIDTRANS_MERCHANT_NOT_ACTIVE	Internal System Error.
1801	INTENT_NOT_SUPPORTED	Internal System Error.
1802	WALLET_DETAILS_MISSING	Internal System Error.
1803	WALLET_TYPE_WRONG_FOR_INTENT	Internal System Error.
1804	PAYMENT_REQUEST_ALREADY_FULFILLED	Internal System Error.
1805	ORDER_ID_REFERENCE_ID_NOT_MATCHED	Internal System Error.
1806	RECEIVER_WALLET_ID_NOT_MATCHED	Internal System Error.
1807	INTENT_NOT_MATCHED	Internal System Error.
1808	PAYMENT_REQUEST_DETAILS_MISSING	Internal System Error.
1809	ACCOUNTING_CATEGORY_NOT_MATCHED	Internal System Error.
1810	METADATA_MALFORMED	Internal System Error.
1811	PAYMENT_REQUEST_NOT_FOUND	Internal System Error.
1812	ORDER_ID_NOT_UNIQUE	Internal System Error.
1813	SENDER_WALLET_ID_NOT_MATCHED	Internal System Error.
1814	SENDER_RECEIVER_WALLET_SAME	Internal System Error.
1815	PAYMENT_REQUEST_INITIATED_BUT_OTP_FAILED	Internal System Error.
1816	AUTHORIZATION_NOT_REQUIRED	Internal System Error.
1817	PAYMENT_REQUEST_NOT_FULFILLED	Internal System Error.
1818	PAYMENT_REQUEST_ALREADY_CANCELLED	Internal System Error.
1819	PAYMENT_REQUEST_NOT_IN_INITIATED_STATE	Internal System Error.
1820	PAYMENT_REQUEST_WITH_PROMO_CODES_NOT_FOUND	Internal System Error.
1821	BAD_CREATE_PAYMENT_REQUEST	Internal System Error.
1822	EXCEEDED_PERMISSIBLE_AMOUNT	Internal System Error.
1823	PAYMENT_REQUEST_EXPIRED	Internal System Error.
1901	REKPON_INVALID_BANK_ACCOUNT_NUMBER	Internal System Error.
1902	REKPON_INVALID_BANK_ACCOUNT_NAME	Internal System Error.
2001	REFUND_REQUESTED_EXCEEDS_ORIGINAL_TRANSACTION	Internal System Error.
2002	REFUND_ALREADY_PROCESSED	Internal System Error.
2003	REFUND_ALREADY_EXPIRED	Internal System Error.
2100	POINTS_INVALID_EXCHANGE_REQUEST	Internal System Error.
2101	INVALID_AMOUNT	Internal System Error.
2103	DUPLICATE_POINTS_EXCHANGE_REQUEST	Internal System Error.
2201	PROMO_NOT_APPLICABLE	Internal System Error.
2202	PROMO_CODE_NOT_VALID	Internal System Error.
2203	PROMO_CODE_EXPIRED	Internal System Error.
2204	INVALID_PROMO_VALID_FROM	Internal System Error.
2205	INVALID_PROMO_VALID_TILL	Internal System Error.
2206	ACTIVE_PROMOTION_UPDATION_REQUEST	Internal System Error.
2301	SERVICE_BLOCKING_INVALID_SERVICE	Internal System Error.
2400	INVALID_VOUCHER_SEARCH_REQUEST	Internal System Error.
2500	INVALID_ENROLLMENT	Internal System Error.
2601	EXPLORE_TYPE_UNSUPPORTED	Internal System Error.
2602	EXPLORE_CODE_NOT_IDENTIFIED	Internal System Error.
2603	EXPLORE_INVALID_FORMAT	Internal System Error.
2604	EXPLORE_MERCHANT_INFORMATION_ERROR	Internal System Error.
2700	INVALID_WALLET_COUNTRY	Internal System Error.
2800	EXCHANGE_CUTOFF_IN_PROCESS	Internal System Error.
2801	EXCHANGE_SYSTEM_FAILURE	Internal System Error.
2802	EXCHANGE_SIGNATURE_NOT_MATCH	Internal System Error.
2803	EXCHANGE_ADDITIONAL_DATA	Internal System Error.
2804	INVALID_REQUEST_TIMESTAMP	Internal System Error.
2901	DUPLICATE_TRANSACTION_REQUEST	Internal System Error.

JSON Object

Collection of JSON objects that are used in API Methods

Transaction Details

"transaction_details": {
    "order_id": "A87551",
    "gross_amount": 145000
}

JSON Attribute	Type	Required	Description
order_id	String(50)	Y	Order id of the transaction NOTE: Allowed Symbols are dash(-), underscore(_), tilde (~), and dot (.)
gross_amount	Long	Y	Gross value of the transaction NOTE: Don't add decimal

Credit Card

"credit_card": {
    "token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
    "bank": "bni",
    "installment_term": 6,
    "bins": ["4811", "5233"],
    "type": "authorize",
    "save_token_id": true
}

JSON Attribute	Type	Required	Description
token_id	String(255)	Y	Token id represents customer credit card information
bank	String(255)	N	Acquiring bank. Valid values: mandiri, bni, cimb, bca, maybank, and bri
installment_term	integer	N	installment_term
bins	JSON Array	N	List of credit card's BIN (Bank Identification Number) that is allowed for transaction
type	String (255)	N	Used on preauthorization feature. Valid value: authorize
save_token_id	Boolean	N	Used on 'one click' or 'two clicks' feature. Enabling it will return a saved_token_id that can be used for the next transaction

Item Details

"item_details": [{
    "id": "a1",
    "price": 50000,
    "quantity": 2,
    "name": "Apel",
    "brand": "Fuji Apple",
    "category": "Fruit",
    "merchant_name": "Fruit-store",
    "tenor": "12",
    "code_plan": "000",
    "mid": "123456"
  }]

JSON Attribute	Type	Required	Description
id	String	N	Item ID
price	Number	Y	Price of the item NOTE: Don't add decimal
quantity	Number	Y	Quantity of the item bought
name	String	Y	Name of the item
brand	String	N	Brand of the item
category	String	N	Category of the item
merchant_name	String	N	Merchant name selling the item
tenor	Numeric(2)	C	Installment term, use 2 digits numeric (03, 06, 09, 12, 24) NOTE: BCA KlikPay exclusive field
code_plan	Numeric(3)	C	Installment code, use 000 for default NOTE: BCA KlikPay exclusive field
mid	Numeric(9)	C	Installment mid NOTE: BCA KlikPay exclusive field

WARNING: Please avoid using vertical line (|) for Alfamart payment type. item_details is required for Akulaku payment type.

Customer Details

"customer_details": {
  "first_name": "TEST",
  "last_name": "UTOMO",
  "email": "test@midtrans.com",
  "phone": "+628123456",
  "billing_address": {
    "first_name": "TEST",
    "last_name": "UTOMO",
    "phone": "081 2233 44-55",
    "address": "Sudirman",
    "city": "Jakarta",
    "postal_code": "12190",
    "country_code": "IDN"
  },
  "shipping_address": {
    "first_name": "TEST",
    "last_name": "UTOMO",
    "phone": "0 8128-75 7-9338",
    "address": "Sudirman",
    "city": "Jakarta",
    "postal_code": "12190",
    "country_code": "IDN"
  }
}

JSON Attribute	Type	Required	Description
first_name	String(255)	N	Customer's first name
last_name	String(255)	N	Customers last name
email	String(255)	N	Customer's email address
phone	String(255)	N	Customer's phone address
billing_address	N	JSON Array	Customer's billing address
shipping_address	N	JSON Array	Customer's shipping address

WARNING: Please limit customer names (first name and last name) to only 30 characters for BCA VA.

Billing address

JSON Attribute	Type	Required	Description
first_name	String(255)	N	Customer's billing first name
last_name	String(255)	N	Customers billing last name
phone	String(255)	N	Customer's billing phone address
address	String(255)	N	Detail address of the billing address
city	String(255)	N	City of the billing address
postal_code	String(255)	N	Postal code of the billing address. Note: Format is alpha-numeric. It can accept "-" and space
country_code	String(3)	N	Country ID of the billing address. (e.g IDN) ISO 3166-1 alpha-3

Shipping address

JSON Attribute	Type	Required	Description
first_name	String(255)	N	Customer's shipping first name
last_name	String(255)	N	Customers shipping last name
phone	String(255)	N	Customer's shipping phone address
address	String(255)	N	Detail address of the shipping address
city	String(255)	N	City of the shipping address
postal_code	String(255)	N	Postal code of the shipping address. Note: Format is alpha-numeric. It can accept "-" and space
country_code	String(3)	N	Country ID of the shipping address. (e.g IDN) ISO 3166-1 alpha-3

Bank Transfer

Bank Transfer BCA VA Object

"bank_transfer":{
  "bank": "bca",
  "va_number": "111111",
  "free_text": {
       "inquiry": [
             {
                 "id": "Free Text ID Free Text ID Free Text ID",
                 "en": "Free Text EN Free Text EN Free Text EN"
             }
       ],
       "payment": [
             {
                 "id": "Free Text ID Free Text ID Free Text ID",
                 "en": "Free Text EN Free Text EN Free Text EN"
             }
       ]
  },
  "bca": {
    "sub_company_code": "00000"
  }
}

Bank Transfer Permata VA Object

"bank_transfer":{
  "bank": "permata",
  "va_number": "111111",
  "permata": {
    "recipient_name": "SUDARSONO"
  }
}

JSON Attribute	Type	Required	Description
bank	String(255)	Y	Bank name which process bank transfer transaction. Valid value is permata, bni, and bca
va_number	String(255)	N	Custom va number assigned by merchant. If shorter than minimum then we will add trailing 0s as most significant bits. If longer than maximum then we will trim the remaining least significant bits. BCA VA: Accepts 6-11 digits Permata VA Facilitator: Accepts 10 digits BNI VA: Accepts 8 (For 5 digits Client ID) or 12 digits (For 3 digits Client ID)
free_text	JSON Array	N	list of free texts NOTE: Right now only used for BCA VA
bca	JSON Object	N	Specific parameters for BCA VA
permata	JSON Object	N	Specific parameters for Permata VA

JSON Attribute	Type	Required	Description
inquiry	JSON Array(10)	N	Free texts shown during inquiry
payment	JSON Array(10)	N	Free texts shown during payment

JSON Attribute	Type	Required	Description
id	String(50)	Y	Free text message in Bahasa Indonesia
en	String(50)	Y	Free text message in English

JSON Attribute	Type	Required	Description
sub_company_code	String	N	BCA sub company code directed for this transactions NOTE: Default is 00000

JSON Attribute	Type	Required	Description
recipient_name	String	N	Recipient name shown on the payment details. It is shown as 20 digit uppercase string. NOTE: Default is merchant name

Echannel

"echannel" : {
    "bill_info1" : "Payment For:",
    "bill_info2" : "Tuition fee",
    "bill_info3" : "Name:",
    "bill_info4" : "Budi Utomo",
    "bill_info5" : "Class:",
    "bill_info6" : "Computer Science",
    "bill_info7" : "ID:",
    "bill_info8" : "VT-12345"
}

JSON Attribute	Type	Required	Description
bill_info1	String(255)	Y	Label 1. Mandiri only allows 10 characters. Exceeding characters will be truncated.
bill_info2	String(255)	Y	Value for Label 1. Mandiri only allows 30 characters. Exceeding characters will be truncated.
bill_info3	String(255)	N	Label 2. Mandiri only allows 10 characters. Exceeding characters will be truncated.
bill_info4	String(255)	N	Value for Label 2. Mandiri only allows 30 characters. Exceeding characters will be truncated.
bill_info5	String(255)	N	Label 3. Mandiri only allows 10 characters. Exceeding characters will be truncated.
bill_info6	String(255)	N	Value for Label 3. Mandiri only allows 30 characters. Exceeding characters will be truncated.
bill_info7	String(255)	N	Label 4. Mandiri only allows 10 characters. Exceeding characters will be truncated.
bill_info8	String(255)	N	Value for Label 4. Mandiri only allows 30 characters. Exceeding characters will be truncated.

VA Number

"va_numbers": [
  {
    "bank": "bca",
    "va_number": "91019021579"
  }
]

JSON Attribute	Type	Required	Description
bank	String(255)	Y	Bank name which process bank transfer transaction. Valid value is permata, bii, and bca
va_number	String(255)	Y	Virtual account number generated

Payment Amount

"payment_amounts": [
  {
    "paid_at": "2016-06-19 20:12:22",
    "amount": "20000.00"
  }
]

JSON Attribute	Type	Required	Description
paid_at	String	Y	Payment time
amount	String	Y	Amount paid

Mandiri Clickpay

"mandiri_clickpay": {
  "token_id": "4811117d16c884-2cc7-4624-b0a8-10273b7f6cc8",
  "input3": "00000",
  "token": "000000"
}

JSON Attribute	Type	Required	Description
token_id	String(255)	Y	Token id represents customer debit card information
input3	String(5)	Y	Unique user generated id
token	String(6)	Y	Token generated from Mandiri Clickpay APPLI 3 token based on input1 (Last 10 digits of card_number), input2 (Equivalent to gross_amount), and input3

BCA Klikpay

"bca_klikpay": {
  "description": "Pembelian Barang"
}

JSON Attribute	Type	Required	Description
description	String(60)	Y	BCA Klikpay transaction description
misc_fee	Long	N	Additional fee for documentation

BCA Klikbca

"bca_klikbca" : {
  "description" : "3176440",
  "user_id" : "midtrans1012"
}

JSON Attribute	Type	Required	Description
description	String(60)	Y	Klikbca transaction description
user_id	String(12)	Y	Klikbca User ID

CIMB Clicks

"cimb_clicks": {
    "description": "Purchase of a special event item"
}

JSON Attribute	Type	Required	Description
description	String(100)	Y	Description which will be shown on the CIMB email notification.

Convenience Store

"cstore" : {
  "store" : "indomaret",
  "message" : "mangga",
  "alfamart_free_text_1": "1st row of receipt,",
  "alfamart_free_text_2": "This is the 2nd row,",
  "alfamart_free_text_3": "3rd row. The end."
}

JSON Attribute	Type	Required	Description
store	String(20)	Y	Store name
message	String(20)	N	Label to be displayed in Indomaret POS
alfamart_free_text_1	String (40)	N	Customize the first row of description in Alfamart printed receipt
alfamart_free_text_2	String (40)	N	Customize the second row of description in Alfamart printed receipt
alfamart_free_text_3	String (40)	N	Customize the third row of description in Alfamart printed receipt

Action

{
    "name": "cancel",
    "method": "POST",
    "url": "https://api.midtrans.com/v2/e48447d1-cfa9-4b02-b163-2e915d4417ac/cancel",
    "fields": []
}

JSON Attribute	Type	Required	Description
name	String	Y	Action name
method	String	Y	HTTP method used for the action
url	String	Y	HTTP URL target for the action
fields	Array(String)	C	Parameters which can be sent for the action. Only for method other than GET.

Gopay

"gopay": {
  "enable_callback": true,
  "callback_url": "someapps://callback"
}

JSON Attribute	Type	Required	Description
enable_callback	Boolean	N	To determine appending callback url in the deeplink. Default value: false
callback_url	String	N	To determine where GO-JEK apps will redirect after successful payment. Can be HTTP or deeplink url. Default value: callback_url in dashboard settings

Subscription Schedule

"schedule": {
  "interval": 1,
  "interval_unit": "month",
  "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"
}

JSON Attribute	Type	Description
interval	Integer	Subscription's interval given by merchant Note: only allowed 1-12 value
interval_unit	String	Interval temporal unit Note: currently only support month
start_time	String	Timestamp of Subscription
previous_execution_at	String	Timestamp of last succeeded charge. Note: on create subscription, timestamp value will be the same as start_time
next_execution_at	String	Timestamp of next scheduled charge

Transaction Status

Transaction Status used by Midtrans API.

Status	Description	Possible change(s)
authorize	Transaction authorizes the credit card. Must be captured to process the balance. Note: Credit Card only	capture, cancel
capture	Transaction captures the credit card balance. Will be settled as batch.	settlement, cancel
settlement	Transaction is settled.	refund, chargeback, partial_refund, partial_chargeback
deny	Payment provider rejects the credentials used for payment. See status_message for deny details.	N/A
pending	Transaction is made available in Midtrans to be paid.	settlement, deny, cancel, expire
cancel	Transaction is cancelled. Can be triggered by Midtrans or partner themselves.	N/A
refund	Transaction is marked to be refunded.	settlement
partial_refund	Transaction is marked to be partially refunded.	settlement
chargeback	Transaction is marked to be charged back. Note: Credit Card only	settlement
partial_chargeback	Transaction is marked to be partially charged back.	settlement
expire	Transaction no longer available to be paid or processed	N/A
failure	Unexpected error during transaction processing	N/A

Fraud Status

Fraud Status used by Midtrans API.

Status	Description
accept	Transaction is not considered as fraud.
deny	Transaction is considered as fraud.
challenge	We cannot determine the transaction. Merchant should take action to accept or deny. via Merchant Administration Portal, or via Approve or Deny API

API changelog

Version 3.48.0

February 14, 2019

• Add direct refund API

Version 3.46.0

February 6, 2019

• Add Over the Counter - Alfamart

Version 3.44.0

January 22, 2019

• Major update to Credit Card 3DS Flow (Excluding Point Inquiry API). This change mostly affects the flow for 3D Secure transactions.

Version 3.33.0

November 13, 2018

• Add BIN API

Version 3.19.1

September 19, 2018

• Add card_type on credit card response and notification payload

Version 3.16.0

August 21, 2018

• Add Customer Financing - Akulaku

Version 3.4.0

July 3, 2018

• Add currency on response payload for most payment channels

Version 3.2.2

January 9, 2018

• Remove QR code integration for GO-PAY

Version 3.1.15

November 21, 2017

• Add GO-PAY (Beta)

Version 3.1.13

November 7, 2017

• Add permata.recipient_name parameter on Permata VA charge request.
• Makes channel parameter on Credit Card charge request and token card object to be optional.

Version 3.1.11

November 1, 2017

• Enable merchant to put metadata on charge request

Version 3.1.6

October 10, 2017

• Add Channel Response Code tables.

Version 3.1.3

September 20, 2017

• Add channel_response_code and channel_response_message on credit card charge response

Version 3.1.2

September 12, 2017

• Add point_redeem_quantity on credit card charge response
• Add bca.sub_company_code on bank transfer charge request
• Update on refund_amount showing the cumulative amount refunded

Version 3.1.1

September 7, 2017

• Remove input1 and input2 to simplify mandiri_clickpay JSON object

Version 3.0.6

August 31, 2017

• New flow for Mandiri ClickPay

Version 2.24.12

June 8, 2017

• Add Credit Card Point for Mandiri acquiring

Version 2.24.10

May 24, 2017

• Add BNI Virtual Account
• Add credit card point feature

Version 2.24.2

April 6, 2017

• Add Card Promo Payment (Beta).

Version 2.23.1

March 9, 2017

• BCA KlikPay request now doesn't require type. We will generate it based on the item_details.
• All payment type now doesn't require item_details
• Add Refund API. See API Methods.
• Add Get Status B2B API. See API Methods.

Version 2.21.10

January 13, 2017

• KlikBCA reconciliation reference is now the same value as Midtrans order id if the order id is alphanumeric and its length is less than or equals to 18. Otherwise, we will generate a 18 length alphanumeric for the reconciliation reference. This value can be found on charge response body, field: approval_code.

Version 2.21.3

December 6, 2016

• Mandiri Bill now supports facilitator scheme, contact your Solutions to get your personal biller code

Version 2.10.0

November 23, 2016

• Add biller code in Mandiri Bill notification
• Prohibit the use of decimal in gross_amount and item_details.price

Version 2.9.10

October 28, 2016

• Performance improvements for VTWeb

Version 2.9.9

October 25, 2016

• Misc performance improvements for all our API
• Fix bug with Mandiri ecash expiry on /v2/status

Version 2.9.7

October 19, 2016

Added Changelog for Midtrans API

Deprecation Notices

November 7, 2017

Starting on February 1st, 2018, channel parameter from Token Card Object and Charge Request Credit Card Object will be permanently removed. Once it is effective, any channel parameter sent to Midtrans' system will be disregarded. We advise you to remove channel parameter on your end immediately.

Following this announcement, we have made channel parameter as optional. However, should you choose to do a transaction via MIGS banks, you will need to send ‘bank’ parameter to Midtrans. Below are few instances where changes might occur:

1. Merchant sends no channel, no bank: choose any non-MIGS bank
2. Merchant sends MIGS channel, no bank: choose any MIGS bank
3. Merchant sends no channel, MIGS bank: choose a specific MIGS bank
4. Merchant sends MIGS channel, MIGS bank: choose a specific MIGS bank
5. Merchant sends no channel, non-MIGS bank: choose a specific non-MIGS bank
6. Merchant sends MIGS channel, non-MIGS bank: 402 Error (No MID/TID available)

Please avoid option number 2, 4, and 6 (where channel parameter is used) in all scenarios.

Notes: MIGS banks: BCA, MAYBANK, or BRI Non-MIGS banks: BNI, CIMB, MANDIRI, OR MEGA

August 31, 2017

We are improving our API to meet your security needs. Currently, Mandiri Clickpay API payload consists of full PAN number which has risk of leaking customer card data.

We are introducing the new flow for Mandiri Clickpay. This new flow will enable you to exchange customer card data for a token_id on client side. Consequently, the token_id is passed as Mandiri Clickpay parameter instead of card_number.

We highly suggest you to update your Mandiri Clickpay implementation to cater this new flow since we are going to deprecate the old implementation by 1st December 2017. Please see Mandiri ClickPay for implementation details.

August 3, 2017

We are limiting the characters to make sure that Order IDs are URL safe starting 1st November 2017. Please see Transaction Details Object for details.

December 1, 2016

We are going to prohibit the use of decimal gross_amount starting 15th January 2017. Below are the examples of valid and invalid parameters.

Example:

• "10000" : valid
• 10000 : valid
• "10000.00" : valid
• "10000.01" : invalid

Invalid gross_amount will be rejected with 400 (validation error) status code.

• User-Agent header in the HTTP notification from Midtrans will no longer be 'Veritrans'. It will be the same as the http client we are using in code. Please do not use the User-Agent Header or depend on it In line with the change of the name of the organization, we will also deprecate the usage of veritrans.co.id domain in the next 3-4 months. This includes the following domains

• api.veritrans.co.id changes to api.midtrans.com

• vtweb2.veritrans.co.id changes to vtweb2.midtrans.com
• app.veritrans.co.id changes to app.midtrans.com
• payments.veritrans.co.id changes to payments.midtrans.com

Please switch to using the new hostnames and URL's immediately to avoid failures.