Close VA
Status of Close VA
Use the Close Virtual Account status endpoint to confirm whether an exact-amount VA payment is still pending, already paid, completed, or expired. This status check helps your system reconcile customer bank transfers, handle delayed callbacks, and update order or invoice records with the latest payment state.
Request Parameters
| Key Parameters | Data Type | Description |
|---|---|---|
| publicAccessToken | String | One time access-token generated using the auth token API |
| vaId | String | Unique Id of virtual account |
Response Parameters
| Key parameters | Data type | Description |
|---|---|---|
| id | String | Unique ID generated by Brick |
| type | String | Type of VA |
| amount | Double | The amount that will be stated in the virtual account |
| description | String | The description that will be stated in the virtual account (maximum 255 characters) |
| createdAt | Timestamp | The time when the close VA is created |
| expiredAt | Timestamp | The expiration time of the close VA (minimum 60 minutes from request time and maximum 30 days from request time) |
| bankShortCode | String | Institution short code of the bank |
| referenceId | String | Unique ID that is being generated by the client to track each VA generation (maximum 255 characters) |
| displayName | String | Display name shown in the customer's payment platform (maximum 24 characters). |
| accountNo | String | digits Virtual Account Numbers that can be used for the payments |
| status | String | The VA Status of whether its "Pending/Paid/Completed/Expired" |
Last modified on