Content-type

String

M

Media type of the resource, i.e. application/json

X-TIMESTAMP

String

M

Client’s current local time in ISO-8601 format

X-SIGNATURE

String

M

Created using symmetric signature HMAC_SHA512 algorithm

Authorization

String

M

Represents access_token of a request; string starts with keyword “Bearer ” followed by access_token. Can get this token from Access Token B2B API response.

Authorization-Customer

String

M

accessToken which Gopay will be sharing once linking is complete. string starts with keyword “Bearer ”followed by access_token.

X-PARTNER-ID

String

M

Unique identifier for caller

X-EXTERNAL-ID

String

M

Alphanumeric string. We suggest merchant to use UUID format. The value should be unique.
In case of timeout, merchant can do:

1. Use this value in get status API to get status transaction or
   
2. Retry this request with the same X-EXTERNAL-ID and request body to avoid creating duplicate transaction

CHANNEL-ID

String

M

Mandatory field from Bank Indonesia that can take any value with correct format 5 digits numeric string

X-DEVICE-ID

String

M

Device identification on which the API services are currently being accessed by the end user (customer).

Sample:
Web Application:
Mozilla / 5.0(Windows NT 10.0; Win64; x64)AppleWebKit / 537.36(KHTML, like Gecko)Chrome / 75.0.3770.100 Safari / 537.36 OPR / 62.0.3331.99

Mobile Application:
Android: android-20013adf6cdd8123f
iOS: 72635bdfd223yvjm7246nsdj34hd4559393kjh42

partnerReferenceNo

String (64)

M

Merchant order-id

Only used for debugging purposes on the server side.

merchantId

String(64)

M

Merchant’s unique ID provided by Midtrans.

amount

Object

O

Transaction amount

amount.value

String (ISO4217)

M

Net amount of the transaction. If it's IDR then value includes 2 decimal digits. e.g. IDR 10.000,- will be placed with 10000.00

amount.currency

String(3)

M

Currency

title

String(256)

M

Order title

items

Array of Object

O

Item details

items.id

String(32)

O

Item ID

items.price

Object

M

Price of the item

items.price.value

String (ISO4217)

M

Item price value

items.price.currency

String

M

Item price currency

items.quantity

String(16)

M

Item quantity

items.name

String(64)

M

Item name

items.brand

String(64)

O

Brand name of the item

items.category

String(64)

O

Category of the item

items.merchantName

String(64)

O

Name of the merchant selling the item.

additionalInfo

Object

M

Additional Information

additionalInfo.merchantCrossReferenceId

String (64)

C

Merchant cross reference id (payment flow identifier). Will be mandatory for Midtrans merchants with custom integration. Midtrans team will let you know when you need to pass this indentifier.

additionalInfo.payOptionDetails.payOption

String (64)

C

Payment option which shows the provider of this payment. This parameter is mandatory unless merchants have custom integration with Midtrans. Midtrans team will let you know if this parameter is optional in the case of custom integration.

Possible value: GOPAY_WALLET, GOPAY_WALLET_POCKET

additionalInfo.payOptionDetails.payMethod

String (64)

M

Possible value: GOPAY

additionalInfo.payOptionDetails.transAmount

Object

M

Payment transaction amount

additionalInfo.payOptionDetails.transAmount.value

String (16,2)

M

Transaction amount that will be paid using this payment method If it's IDR then value includes 2 decimal digits.

e.g. IDR 10.000,- will be placed with 10000.00

additionalInfo.payOptionDetails.transAmount.currency

String (3)

M

IDR

additionalInfo.payOptionDetails.additionalInfo.paymentOptionToken

String

C

Payment option token . This parameter is mandatory unless merchants have custom integration with Midtrans. Midtrans team will let you know if this parameter is optional in the case of custom integration.

additionalInfo.customerDetails

Object

O

Customer detail information

additionalInfo.customerDetails.phone

String(15)

O

Customer phone number

additionalInfo.customerDetails.email

String(255)

O

Customer email

additionalInfo.customerDetails.firstName

String(255)

O

Customer first name

additionalInfo.customerDetails.lastName

String(255)

O

Customer last name

additionalInfo.customerDetails.billingAddress

Object

O

Billing address information

additionalInfo.customerDetails.billingAddress.firstName

String(255)

O

Billing address first name

additionalInfo.customerDetails.billingAddress.lastName

String(255)

O

Billing address last name

additionalInfo.customerDetails.billingAddress.phone

String(15)

O

Billing address phone number

additionalInfo.customerDetails.billingAddress.address

String(255)

O

Billing address detail

additionalInfo.customerDetails.billingAddress.city

String(255)

O

Billing address city

additionalInfo.customerDetails.billingAddress.postalCode

String(255)

O

Billing address postal code

additionalInfo.customerDetails.billingAddress.countryCode

String(15)

O

Billing address country code

additionalInfo.customerDetails.shippingAddress

Object

O

Shipping address information

additionalInfo.customerDetails.shippingAddress.firstName

String(255)

O

Shipping address first name

additionalInfo.customerDetails.shippingAddress.lastName

String(255)

O

Shipping address last name

additionalInfo.customerDetails.shippingAddress.phone

String(15)

O

Shipping address phone number

additionalInfo.customerDetails.shippingAddress.address

String(255)

O

Shipping address detail

additionalInfo.customerDetails.shippingAddress.city

String(255)

O

Shipping address city

additionalInfo.customerDetails.shippingAddress.postalCode

String(255)

O

Shipping address postal code

additionalInfo.customerDetails.shippingAddress.countryCode

String(15)

O

Shipping address country code

additionalInfo.validUpTo

String(25)

O

The time when the payment will be automatically expired. Using ISO 8601 format

(Maximum value: 180 days from trx time, Minimum value: 20 second, default value: 7 days)

Content-type

String

M

Media type of the resource, i.e. application/json

X-TIMESTAMP

String

M

Client’s current local time in ISO-8601 format

responseCode

String (7)

M

Error code to specify the error returned.

responseMessage

String (150)

M

Debug message to provide more information.

referenceNo

String (256)

O

Unique transaction identifier from payment provider system e.g : Gopay order ID.

partnerReferenceNo

String (32)

O

Unique transaction identifier from Merchant (Merchant order ID).

paidTime

String (25)

M

Transaction paid time. ISO 8601 YYYY-MM-DDThh:mm:ss

additionalInfo

Object

O

Additional information

additionalInfo.amount

Object

O

Transaction Total Amount Object

additionalInfo.amount.value

String

M

Net amount of the refund. If it's IDR then the value includes 2 decimal digits.

e.g. IDR 10.000,- will be placed with 10000.00

additionalInfo.amount.currency

String

M

Currency

additionalInfo.transactionTime

String

O

Timestamp of transaction in ISO 8601 format. Time zone: GMT+7.

additionalInfo.transactionStatus

String

O

Status of GoPay transaction.

Possible Values:

• 00 - Success
• 01 - Authorize
• 04 - Refunded
• 05 - Canceled
• 06 - Failed

additionalInfo.fraudStatus

String

O

Fraud status

additionalInfo.payOptionDetails

Array of Object

M

Payment option detail

additionalInfo.payOptionDetails.payMethod

String

M

Gopay

additionalInfo.payOptionDetails.payOptions

String

M

Gopay payment option used

additionalInfo.validUpTo

String(25)

O

The time when the payment will be automatically expired. Using ISO 8601 format

2006300

200

Success

4006302

400

Invalid Mandatory Field {Field Name}

4016300

401

Unauthorized. Auth token required

4016301

401

Invalid Token (B2B)

4016302

401

Invalid Customer Token

4031003

403

Suspected Fraud

4031014

403

Insufficient Funds

5006301

500

Internal Server Error

5046300

504

Timeout

Content-type

String

M

Media type of the resource, i.e. application/json

X-TIMESTAMP

String

M

Client’s current local time in ISO-8601 format

X-SIGNATURE

String

M

Created using symmetric signature HMAC_SHA512 algorithm

Authorization

String

M

Represents access_token of a request; string starts with keyword “Bearer ” followed by access_token. Can get this token fromAccess Token B2B API response.

X-PARTNER-ID

String

M

Unique identifier for caller (client_id)

X-EXTERNAL-ID

String

M

Alphanumeric string. We suggest merchant to use UUID format. The value should be unique.
In case of timeout, merchant can do:

1. Use this value in get status API to get status transaction or
   
2. Retry this request with the same X-EXTERNAL-ID and request body to avoid creating duplicate transaction

CHANNEL-ID

String

M

Mandatory field from Bank Indonesia that can take any value with correct format 5 digits numeric string

originalReferenceNo

String(64)

C

Transaction identifier on service provider system. For e.g: GopayOrderId

Note: either additionalInfo.originalExternalId or OriginalReferenceNo need to be filled

If both fields have value, will use originalReferenceNo as the main identifier.

originalPartnerReferenceNo

String (64)

M

Merchant order id

merchantId

String(64)

M

Merchant’s unique ID provided by Midtrans.

partnerCaptureNo

String (64)

M

Capture identifier generated by the partner

captureAmount

String

O

Transaction amount that merchant wants to capture. Currently only full capture is supported.

captureAmount.value

String

M

Capture amount value

captureAmount.currency

String

M

Capture amount currency

title

String(256)

M

Order title

additionalInfo

additionalInfo.originalExternalId

String (36)

C

If merchant got a timeout from the auth endpoint, merchant can use this field using the X-EXTERNAL-ID value in the direct debit request header.

Note: either originalExternalId or OriginalReferenceNo need to be filled

Content-type

String

M

Media type of the resource, i.e. application/json

X-TIMESTAMP

String

M

Client’s current local time in ISO-8601 format

responseCode

String (7)

M

Error code to specify the error returned.

responseMessage

String (150)

M

Debug message to provide more information.

originalReferenceNo

String (256)

O

Transaction identifier on service provider system. For e.g: GopayOrderId

originalPartnerReferenceNo

String (32)

O

Transaction identifier on service consumer system

captureNo

String (64)

C

PJSP's capture identifier. Used to trace the capture when there's any issue occurred.

partnerCaptureNo

String (64)

O

Capture identifier generated by the partner

captureAmount

captureAmount.value

String (16,2)

O

Transaction amount that will be paid using this payment method If it's IDR then value includes 2 decimal digits.

e.g. IDR 10.000,- will be placed with 10000.00

captureAmount.currency

String

O

Currency For e.g: IDR

captureTime

String(25)

C

Capture time. Format capture time: (ISO 8601) YYYY-MM-DDThh:mm:ss. Must be filled upon successful transaction

2006500

200

Successful

4006502

400

Invalid Mandatory Field {Field Name}

4016500

401

Unauthorized. Auth token required

4016501

401

Invalid Token (B2B)

4036515

403

Transaction Not Permitted.[reason].

5006501

500

Internal Server Error

5046500

504

Timeout