Virtual Account

Server

Download schema

Status of Open VA

GET

https://sandbox.onebrick.io/v2/payments/general

/va/open

Check the latest status of an Open Virtual Account payment by using the VA status endpoint.

Status of Open VA › query Parameters

vaId

string · required

Unique id of virtual account ex: OP_xxxx

Status of Open VA › Responses

200

status

integer

Default: 0

object

error

Generate Open VA

POST

https://sandbox.onebrick.io/v2/payments/general

/va/open

Generate an Open Virtual Account that customers can reuse for flexible payment amounts.

Generate Open VA › Request Body

bankShortCode

string · required

Institution short code of the bank

Default: MANDIRI

referenceId

string · required

Unique ID that is being generated by the client to track each VA generation (maximum 255 characters)

Default: test-VA-1

displayName

string · required

Display name shown in the customer's payment platform (maximum 24 characters).

Default: PRODONLY

Generate Open VA › Responses

200

status

integer

Default: 0

object

error

POST/va/open

curl https://sandbox.onebrick.io/v2/payments/general/va/open \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "bankShortCode": "MANDIRI",
  "referenceId": "test-VA-1",
  "displayName": "PRODONLY"
}'

Example Request Body

{
  "bankShortCode": "MANDIRI",
  "referenceId": "test-VA-1",
  "displayName": "PRODONLY"
}

json

Example Responses

{
    "status": 200,
    "data": {
				"message": "We have successfully generated the open VA",
        "id": "OP_SA123212SDS123123SAD11222",
        "referenceId": "BRICK1234",
				"bankShortCode": "MANDIRI",
        "accountNo": "130432138889902",
        "displayName": "BRICK"
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}

json

application/json

Status of Close VA

GET

https://sandbox.onebrick.io/v2/payments/general

/va/close

Check the latest status of a Close Virtual Account payment by using the VA status endpoint.

Status of Close VA › query Parameters

vaId

string

Unique id of virtual account ex: CL_xxxx

Status of Close VA › Responses

200

status

integer

Default: 0

object

error

Generate Close VA

POST

https://sandbox.onebrick.io/v2/payments/general

/va/close

Generate a Close Virtual Account for a fixed payment amount, expiration time, and customer reference.

Generate Close VA › Request Body

referenceId

string · required

Unique ID that is being generated by the client to track each VA generation

Default: test-closeVA-1

bankShortCode

string · required

Default: MANDIRI

amount

integer · int32 · required

The amount that will be stated in the virtual account

Default: 10000

expiredAt

string · required

The expiration time of the close VA in Minute

Default: 60

displayName

string · required

Displayed name of VA

Default: Close VA test

description

string

The description that will be stated in the virtual account (maximum 255 characters)

Default: test-closeVA-1

Generate Close VA › Responses

200

status

integer

Default: 0

object

error

POST/va/close

curl https://sandbox.onebrick.io/v2/payments/general/va/close \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "referenceId": "test-closeVA-1",
  "bankShortCode": "MANDIRI",
  "amount": 10000,
  "expiredAt": "60",
  "displayName": "Close VA test",
  "description": "test-closeVA-1"
}'

Example Request Body

{
  "referenceId": "test-closeVA-1",
  "bankShortCode": "MANDIRI",
  "amount": 10000,
  "expiredAt": "60",
  "displayName": "Close VA test",
  "description": "test-closeVA-1"
}

json

Example Responses

{
    "status": 200,
    "data": {
				"message": "We have successfully generated the close VA",
        "id": "CL_asd31231SAD123123asasd122",
				"referenceId": "brick12345",
        "description": "Test Initial VA Close",
        "amount": "15000.0",
        "status": "pending",
        "createdAt": "2021-12-13T14:26:43.000+07:00",
        "expiredAt": "2021-12-31T15:27:43.000+07:00",
        "bankShortCode": "MANDIRI",
        "accountNo": "1304421991909265",
        "displayName": "IKN-BRICK"
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}

json

application/json

Simulate Close VA Payment [PAID/COMPLETED]

POST

https://sandbox.onebrick.io/v2/payments/general

/va/close/status/{vaIdCL}

This API is for simulation to test the open VA process, This API is only available in a Sandbox environment.

Simulate Close VA Payment [PAID/COMPLETED] › path Parameters

vaIdCL

string · required

ID of VA that is generated by Brick in the VA generation API response for simulating "paid" status, ID of Payment that is generated by Brick in the VA callback response for simulating "PAID/COMPLETED" status. Ex: CL_xxx

Simulate Close VA Payment [PAID/COMPLETED] › Request Body

action

string · required

The status that want to be achieved (PAID / COMPLETED)

Default: PAID/COMPLETED

Simulate Close VA Payment [PAID/COMPLETED] › Responses

200

Regular Disbursement QRIS Dynamic

Status of Open VA

GET

https://sandbox.onebrick.io/v2/payments/general

/va/open

Check the latest status of an Open Virtual Account payment by using the VA status endpoint.

Status of Open VA › query Parameters

vaId

string · required

Unique id of virtual account ex: OP_xxxx

Status of Open VA › Responses

200

status

integer

Default: 0

object

error

Generate Open VA

POST

https://sandbox.onebrick.io/v2/payments/general

/va/open

Generate an Open Virtual Account that customers can reuse for flexible payment amounts.

Generate Open VA › Request Body

bankShortCode

string · required

Institution short code of the bank

Default: MANDIRI

referenceId

string · required

Unique ID that is being generated by the client to track each VA generation (maximum 255 characters)

Default: test-VA-1

displayName

string · required

Display name shown in the customer's payment platform (maximum 24 characters).

Default: PRODONLY

Generate Open VA › Responses

200

status

integer

Default: 0

object

error

Status of Close VA

GET

https://sandbox.onebrick.io/v2/payments/general

/va/close

Check the latest status of a Close Virtual Account payment by using the VA status endpoint.

Status of Close VA › query Parameters

vaId

string

Unique id of virtual account ex: CL_xxxx

Status of Close VA › Responses

200

status

integer

Default: 0

object

error

Generate Close VA

POST

https://sandbox.onebrick.io/v2/payments/general

/va/close

Generate a Close Virtual Account for a fixed payment amount, expiration time, and customer reference.

Generate Close VA › Request Body

referenceId

string · required

Unique ID that is being generated by the client to track each VA generation

Default: test-closeVA-1

bankShortCode

string · required

Default: MANDIRI

amount

integer · int32 · required

The amount that will be stated in the virtual account

Default: 10000

expiredAt

string · required

The expiration time of the close VA in Minute

Default: 60

displayName

string · required

Displayed name of VA

Default: Close VA test

description

string

The description that will be stated in the virtual account (maximum 255 characters)

Default: test-closeVA-1

Generate Close VA › Responses

200

status

integer

Default: 0

object

error

Simulate Close VA Payment [PAID/COMPLETED]

POST

https://sandbox.onebrick.io/v2/payments/general

/va/close/status/{vaIdCL}

This API is for simulation to test the open VA process, This API is only available in a Sandbox environment.

Simulate Close VA Payment [PAID/COMPLETED] › path Parameters

vaIdCL

string · required

Simulate Close VA Payment [PAID/COMPLETED] › Request Body

action

string · required

The status that want to be achieved (PAID / COMPLETED)

Default: PAID/COMPLETED

Simulate Close VA Payment [PAID/COMPLETED] › Responses

200