Update Virtual Account

patch

https://example.com/api/v1/virtualAccount

This API can update the VA Name, Expires In, Amount, and Virtual Account Type. The BNI VA amount cannot be updated to an amount lower than the previous amount.

The API returns a 200 HTTP response code in the case of a successful update of the virtual account.

The API returns a 401 HTTP response code in case of a missing or invalid token.

The API returns a 503 HTTP response code in case of service unavailable because of bad request (e.g. missing and/or wrong headers), or a validation error (e.g. missing and/or wrong parameters) or any other server issue.

Below is the rule on VA update process, which data that can/can't be updated:

Bank	VA Type	Amount Type	Virtual Account Name	Amount Value	Expiry Time
BNI				Equal or greater than previous amount
BRI				Any amount
Mandiri				Any amount

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

bankCode

string

length between 3 and 3

Bank code of a bank. A customer will get a bank code specified Virtual Account. A Virtual Account number's first 5 digit will differ based on bank.

customerId

string

required

length between 13 and 26

Ayoconnect's CustomerId. AlphaNumeric.

virtualAccountNumber

string

length between 8 and 17

Unique identifier (16-25 numeric characters) to be included to the generated virtual account number. If this parameter is empty in VA Creation Request, then Ayoconnect will generate random value for the VA number.

In VA Creation API Request:
Virtual Account Number consist of Bank Prefix (the first 4 or 5 digits number) and then 3 digits of Merchant Code assigned by Ayoconnect, and the rest could be random number or customized number.
If clients want to define the VA number after the bank prefix, the number should be exactly 12 digits for BNI and should be 11-20 digits for BRI & Mandiri.
In API Responses:
Bank BNI VA: exactly 16 digits
BRI & Mandiri: 16-25 digits

virtualAccountId

string

required

length between 27 and 27

Unique identifier (27 alphanumeric characters) to identify the associated Virtual Account.

transactionId

string

required

length between 32 and 32

Transaction Unique ID generated by the merchant.

virtualAccountName

string

required

length between 1 and 100

This will be used to display the customer name e.g. in ATM.

expiresIn

integer

5 to 1051200

Minutes in which a Virtual Account should expire.

virtualAccountType

enum

The type of the Virtual Account. There are two Virtual Account types:

static: Once a Virtual Account number is generated for a user, the same Virtual Account number will be fixed for all transactions of that user
dynamic: A unique Virtual Account number will be generated for each transaction the user requests

Allowed:

totalAmount

object

Total amount the customer has paid successfully historically through this Virtual Account number.

Headers

Authorization

string

required

length between 35 and 35

Authorization header. Only 'bearer' authentication is supported.

string

required

Content type accepted by the service. Only 'application/json' is supported.

Content-Type

string

required

length between 16 and 16

Content type returned by the service. Only 'application/json' is supported.

A-Correlation-ID

string

required

length between 32 and 32

Unique identifier (32 alphanumeric characters) to identify a Virtual Account flow. It must be unique per flow and can't be reused for different flows. A flow is a set of API calls, for example, all the calls (create, get, update, delete) related to a Virtual Account, and are part of one flow. Merchants can link API calls into one flow using this header.

A-Merchant-Code

string

required

length between 6 and 6

Merchant Code. 6 alphanumeric characters. It is used to identify a merchant.

Responses

200Virtual Account is successfully updated

401If Authorization token is missing or expired.

503If something fails internally, a validation fails or an unexpected error occurs then this error is returned.