partnerReferenceNo

String (64)

M

Merchant order id

Only used for debugging purpose in server side

chargeToken

String

M

The account token used to represent the account binding between merchant and GoPay.

We are not sharing accountToken/accessToken with Merchant. Merchant needs to call the Bind Account API to fetch the accountToken/accessToken.

urlParams

Array of Object

O

Merchant redirect URL.

After completing payment, user will be redirected back to this URL

urlParams.url

String(512)

M

URL value (need to be whitelisted as part of GoPay Tokenization onboarding process)

urlParams.type

String(32)

M

Possible value : PAY_RETURN

urlParams.isDeeplink

String(1)

M

This parameter defines the type of URL to use. Set it to "Y" for a deeplink, or choose "N" if you prefer a standard URL (HTTP/HTTPS)

Possible Value: Y, N

validUpTo

String(25)

O

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

(Maximum value: 180 days from transaction time, minimum value: 20 seconds, default value: 15 minutes)

payOptionDetails

Array of Object

M

Payment option that will be used for this payment

Currently only accept 1 payOptions

payOptionDetails.payMethod

String (64)

M

Payment method. Possible value: GOPAY

payOptionDetails.payOption

String (64)

M

Payment option which shows the provider of this payment

Possible value: GOPAY_WALLET, PAY_LATER

(Value can be acquired from additionalInfo.paymentOptions.name in Account Binding Inquiry API response)

payOptionDetails.transAmount

Object

O

Payment transaction amount

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 as 10000.00

Minimum value: 1.00

Maximum value : 99999999999.00

(item price * item quantity should be the same amount as transAmount)

payOptionDetails.transAmount.currency

String (3)

M

IDR

payOptionDetails.additionalInfo

Object

M

Additional information field which merchants need to pass to support current API contracts.

payOptionDetails.additionalInfo.recurring

String

O

Recurring flag

Possible value : Y/N

If recurring: Y then we will treat this transaction as recurring transaction and bypass PIN challenge. Only applies if recurring feature has already been enabled, please talk to your Midtrans sales representative to have this feature enabled.

payOptionDetails.additionalInfo.promotionIds

Array of String

O

List of promotion ID

Promotion ID can be obtained from Get Promotion API.

payOptionDetails.additionalInfo.paymentOptionToken

String

M

Can get this from Account Binding Inquriy API response.

additionalInfo

Object

O

Additional Information

additionalInfo.merchantCrossReferenceId

String (64)

O

Merchant cross reference id (payment flow identifier)

additionalInfo.lang

String (2)

O

Language code for service
Possible values: en, id.

Default value : id.

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

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

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.items

Array Of Object

O

additionalInfo.items.id

String(32)

O

Item ID

Shall merchant intent to apply SKU based promotion, merchant should pass the agreed item ID value for promotion.

additionalInfo.items.price

Object

M

additionalInfo.items.price.value

String (ISO4217)

M

Item price value (item price * item quantity should be the same amount as transAmount)

additionalInfo.items.price.currency

String

M

Item price currency

additionalInfo.items.quantity

String(16)

M

Item quantity (item price * item quantity should be the same amount as transAmount)

additionalInfo.items.name

String(64)

M

Item name

additionalInfo.items.merchantName

String(64)

O

Name of the merchant selling the item

additionalInfo.items.brand

String(64)

O

Brand name of the item

additionalInfo.items.category

String(64)

O

Category of the item

additionalInfo.metadata

Object

O

Merchant's metadata

additionalInfo.paymentProviderMetadata

Object

C

Object containing the payment provider’s metadata parameter. This is used whenever merchant needs to pass additional information to payment provider.

In the case of GoPay Later Multi Month transaction, merchant needs to pass the required risk data information as agreed with GoPay Later team.

responseCode

String (7)

M

Error code to specify the error returned.

responseMessage

String (150)

M

Debug message to provide more information.

referenceNo

String (256)

M

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

(Only filled if transaction created successfully)

partnerReferenceNo

String (32)

O

Unique transaction identifier from Merchant (Merchant order ID).

webRedirectUrl

String (2048)

M

• If merchant is onboarded to Tokenization webview flow: This will return a GoPay PIN webpage. Merchant should open this link to redirect user to GoPay PIN page to complete payment. Merchant should refer to this field if merchant is onboarded to Tokenization webview flow.

• If merchant is onboarded to Tokenization app redirection flow: This will return a GoPay webpage with a timer as well as payment instructions. User will receive a push notification on their Gojek app to complete payment. Once the customer verifies the transaction on the app, it will be automatically redirected to the merchant page.

• GoPay may add/change GoPay redirection URL from time to time.To ensure merchant can always support GoPay flow at all times, we highly suggest merchant to not do explicit URL whitelisting.

appRedirectUrl

String (2048)

M

This will return a universal link to the Gojek/GoPay app. Use this link to redirect user to GoPay PIN page on Gojek/GoPay app for them to complete payment. Merchant should refer to this field if merchant is onboarded to Tokenization app redirection flow. GoPay may add/change GoPay redirection URL from time to time.To ensure merchant can always support GoPay flow at all times, we highly suggest merchant to not do explicit URL whitelisting.

additionalInfo

Object

O

Additional information

additionalInfo.amount

String (ISO4217)

M

Amount value

additionalInfo.currency

String

M

Amount currency

additionalInfo.status

String

M

Midtrans legacy transaction status

additionalInfo.expiryTime

String (ISO8601)

M

Midtrans legacy expiry transaction time

additionalInfo.paymentType

String

M

Payment type used

additionalInfo.gross_amount

Object

M

additionalInfo.gross_amount.value

String (ISO4217)

M

Gross amount value

additionalInfo.gross_amount.currency

String

M

Gross amount currency

additionalInfo.payOptionDetails

Array of Object.

M

Payment option detail. This parameter will be deprecated soon. We encourage merchant to not consume this parameter and instead consume the parameter additionalInfo.userPaymentDetails instead.

additionalInfo.payOptionDetails.payMethod

String

M

Possible value: gopay

additionalInfo.payOptionDetails.payOption

String

M

GoPay payment option used.
Possible value:
- GoPay =GOPAY_WALLET
-GoPay Later =PAY_LATER
- GoPay Tabungan by Jago = GOPAY_SAVINGS

additionalInfo.userPaymentDetails

Array of Object

M

Payment used by user

additionalInfo.userPaymentDetails.payMethod

String

M

Possible value: gopay

additionalInfo.userPaymentDetails.payOption

String

M

GoPay payment option used.
Possible value:
- GoPay =GOPAY_WALLET
-GoPay Later =PAY_LATER
- GoPay Tabungan by Jago = GOPAY_SAVINGS

additionalInfo.transactionTime

String

O

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

additionalInfo.transactionStatus

String

O

Transaction status

Possible Values:

• 00 - Success
• 03 - Pending
• 04 - Refunded
• 05 - Canceled
• 06 - Failed

additionalInfo.fraudStatus

String

O

Fraud status from Midtrans. Possible values:
- accept --> Transaction is safe to proceed. It is not considered as a fraud.
- deny --> Transaction is considered as fraud. It is rejected by Midtrans.

additionalInfo.validUpTo

String(25)

O

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

2005400

200

Successful

4005402

400

Invalid Mandatory Field chargeToken , partnerReferenceNo

4015400

401

Unauthorized. Auth token required

4015401

401

Invalid Token (B2B)

4015402

401

Invalid Customer Token

4035403

403

Suspected Fraud.

4035405

403

4035414

403

Insufficient Funds

4035415

403

Transaction Not Permitted. Url not whitelisted.

5005401

500

Internal Server Error

5045400

504

Timeout