DocumentationRecipesAPI ReferenceChangelog
Documentation
Start typing to search…

Create Virtual Account

POST/snap/v{version}/transfer-va/create-va

Use this API to initiate:

  • 123 Payment Request

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see：

Request Parameters

trxId String Required

Unique invoice number to identify the order on the merchant side, which is assigned by the merchant.


virtualAccountName String Required

Complete name of the customer. May be used by the channel to verify customer's identity.


totalAmount Object Required

Show Child Parameters

value String Required

The value of the amount as a positive integer in the smallest currency unit.
For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00
or if the currency is IDR and the amount is IDR 10000, set the value of this parameter to 10000

currency String Required

Transaction currency code in 3 alphabetical values as specified in ISO 4217.

If the value is empty, the system will use the merchant's base currency


additionalInfo Object Required

Show Child Parameters

agentCode String Required

Refer to Process By / Channel Code List

agentChannelCode String Required

Refer to Process By / Channel Code List


Response Parameters

responseCode String Required

Response code.

Possible values are listed in the response codes table on this page.


responseMessage String Required

Response message that explains the response code.


redirectUrl String

The URL that redirects customers to an external page in the default browser or the embedded WebView.


additionalInfo Object

Show Child Parameters

explanation String

Note: This field is returned when additionalInfo is returned.

displayTemplate String

Note: This field is only returned for certain payment channel.

type String

Note: This field is only returned for certain payment channel.

expiryDescription String

Note: This field is only returned for certain payment channel.

expiryTimer String

Note: This field is only returned for certain payment channel.

qrData String

Note: This field is only returned for certain payment channel.

barCodeData String

Note: This field is only returned for certain payment channel.

referenceNo String

Note: This field is only returned for certain payment channel.

2C2P Payment Reference No

Updated 26 days ago