Creates a Payment object that will allow you to receive payments on your platform.

Retail Outlet

Example of Retail Outlet Payment Methods Option.

"paymentMethodOptions": {
  "retailOutletName": "ALFAMART",
  "displayName": "test name"
}

Attributes

Type

Description

retailOutletName (*)

string

The retail name used for creating retail outlet Payment Method. This should clearly identify a retail outlet name in the region.

displayName

string

This is the display name that will show up on the retail outlet cashier and payment receipt.

See our guides about Retail Outlet for more information.

Virtual Account

Example of Virtual Account Payment Methods Option.

"paymentMethodOptions": {
  "bankShortCode": "BNI", // choose bank to create the VA
  "displayName": "test name",
  "suffixNo": "12345678"
}

Attributes

Type

Description

bankShortCode (*)

enum

The bank code used for creating the virtual account Payment Method. This should clearly identify a bank in the region. This should be the bank that the end-customer will be making a payment from.

displayName

string

This is the display name that will show up on the online bank transfer or ATM screen.

See our guides about Virtual Account for more information.

QRIS

Example of Virtual Account Payment Methods Option.

"paymentMethodOptions": {
  "displayName": "Your preferred name"
}

Attributes

Type

Description

displayName

string

This is the display name that will show up on the screen.

See our guides about QRIS for more information.

E-Wallet

Example of E-Wallet (currently only support ShopeePay) Payment Methods Option

"paymentMethodOptions": {
  "providerCode": "SHOPEEPAY",
  "afterSettlementReturnUrl": "https://pay.examplessee.co.id/return-pay-here?0340450"
}

Attributes

Type

Description

providerCode

string

The e-wallet channel for creating e-wallet Payment Method. This should be the e-wallet that the end-customer will be making a payment from. Only accept "SHOPEEPAY" at the moment

afterSettlementReturnUrl

string

Url to redirect your user after making a successful payment on e-wallet mobile application

See our guides about E-Wallet for more information.

Language
Authentication
Query