Create Payment Link
Customers use bank virtual accounts to pay merchants
Request#
POST
Parameter#
application/json
| Field | Type | Description |
|---|---|---|
| merchantCode | string [5..50] characters | Unique merchant code |
| orderNum | string | This number should be unique for merchant. Dupliated numbers won't be accepted by platform. |
| payMoney | string | amount to pay |
| productDetail | string <=32 characters | description of the bill |
| method | string Nullable | Payment method, details are below Payment Method list |
| name | string <=32 characters | This name will be displayed on bill page |
string <email> | User email address, if not available, can be any, format required xxx@gmail.com | |
| phone | string | User phone number, if not available, can be any, format required 08xxxxxxxxxx |
| notifyUrl | string <url> | When user completes payment, merchant will be notified on this url |
| redirectUrl | string <url> | Redirect URL after user completes payment |
| expiryPeriod | string [30..7200] characters | order/bill expiration time in minutes |
| dateTime | string <date-time> | format yyyyMMddHHmmss |
| sign | string <=512 characters | Encrypted parameters. |
Request Example#
Response#
Success#
200 application/json
| Field | Type | Description |
|---|---|---|
| platRespCode | string | result code: "SUCCESS" "FAIL" "UNKNOWN" "NOTEXIST" "ERROR" |
| platRespMessage | string | description of resp code |
| platOrderNum | string | unique order number in platform wide. |
| orderNum | string | unique order number in merchant wide. Same as orderNum in request body. |
| name | string <= 32 characters | This name will be displayed on bill page when user pay to the VA |
string <email> | customer email | |
| url | string | payment link |
| payMoney | string | same as field in request body. |
| platSign | string | Encrypted response data |
Response Example#
payment method#
| Code | Description |
|---|---|
| VA_BCA | BCA Bank Repayment Code |
| VA_MANDIRI | Mandiri Bank Repayment Code |
| VA_PERMATA | Permata Bank Repayment Code |
| VA_CIMB | CIMB Bank Repayment Code |
| VA_BNI | BNI Bank Repayment Code |
| VA_BRI | BRI Bank Repayment Code |
| VA_BNC | BNC Bank Repayment Code |
| VA_SAMPOERNA | SAMPOERNA Bank Repayment Code |
| VA_MAYBANK | Maybank Bank Repayment Code |
| VA_DANAMON | Danamon Bank Repayment Code |
| RETAIL_ALFAMART | Alfamart Convenience Store |
| QRIS | QRIS scan code supports all electronic wallets, all kinds of bank scan code payment |
| EWALLET_DANA | DANA Wallet |
| EWALLET_OVO | OVO Electronic Wallet |