Close VA

Server

Hasilkan, pantau, dan simulasikan pembayaran Close VA dalam jumlah tetap. Gunakan titik akhir ini untuk alur pesanan atau faktur yang memerlukan jumlah pasti, jangka waktu kedaluwarsa, dan pemeriksaan status pembayaran Close VA.

Status Close VA

GET

https://sandbox.onebrick.io

/v2/payments/gs/va/close

publicAccessToken (header)

Periksa status pembayaran terbaru untuk Close Virtual Account. Gunakan endpoint ini untuk mengonfirmasi apakah VA dengan jumlah tetap telah dibayar, kedaluwarsa, atau masih menunggu keputusan. Ini berguna untuk rekonsiliasi pesanan, dukungan pelanggan, dan pekerjaan terjadwal yang perlu menyelesaikan pembayaran transfer bank yang belum dibayar atau tertunda.

Status Close VA › query Parameters

vaId

string

Id unik akun virtual misal: CL_xxxx

Status Close VA › Responses

200

status

integer

Default: 0

object

error

Generate Close VA

POST

https://sandbox.onebrick.io

/v2/payments/gs/va/close

publicAccessToken (header)

Hasilkan Tutup Virtual Account untuk jumlah pembayaran tetap, referensi pelanggan, dan jangka waktu kedaluwarsa. Gunakan Close VA ketika setiap pesanan atau invoice harus dibayar dengan jumlah pasti dan masa berlaku terkontrol. Responsnya mengembalikan detail VA yang dapat ditampilkan kepada pelanggan dan kemudian direkonsiliasi melalui callback atau pertanyaan status.

Generate Close VA › Request Body

referenceId

string · required

ID unik yang dihasilkan oleh klien untuk melacak setiap generasi VA

Default: test-closeVA-1

bankShortCode

string · required

Default: MANDIRI

amount

integer · int32 · required

Jumlah yang akan dicantumkan di virtual account

Default: 10000

expiredAt

string · required

Waktu kedaluwarsa penutupan VA dalam Menit

Default: 60

displayName

string · required

Nama VA yang ditampilkan

Default: Close VA test

description

string

Deskripsi yang akan dicantumkan di virtual account (maksimal 255 karakter)

Default: test-closeVA-1

Generate Close VA › Responses

200

status

integer

Default: 0

object

error

POST/v2/payments/gs/va/close

curl https://sandbox.onebrick.io/v2/payments/gs/va/close \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'publicAccessToken: <api-key>' \
  --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

Simulasi Pembayaran Close VA [PAID/COMPLETED]

POST

https://sandbox.onebrick.io

/v2/payments/gs/va/close/status/{vaIdCL}

publicAccessToken (header)

Simulasikan perubahan status pembayaran Close VA di lingkungan sandbox. Gunakan endpoint ini selama pengembangan untuk menguji callbacks, logika rekonsiliasi, penanganan negara berbayar, dan pemulihan kegagalan tanpa memindahkan dana nyata. endpoint ini tidak dimaksudkan untuk lalu lintas produksi dan hanya boleh digunakan dengan data pengujian sandbox VA.

Simulasi Pembayaran Close VA [PAID/COMPLETED] › path Parameters

vaIdCL

string · required

ID dari VA yang dihasilkan oleh Brick di generasi VA respons API untuk simulasi status "berbayar", ID Pembayaran yang dihasilkan oleh Brick di respons VA callback untuk simulasi status "PAID/COMPLETED". Contoh: CL_xxx

Simulasi Pembayaran Close VA [PAID/COMPLETED] › Request Body

action

string · required

Status yang ingin dicapai (PAID / COMPLETED)

Default: PAID/COMPLETED

Simulasi Pembayaran Close VA [PAID/COMPLETED] › Responses

200

Open VA Authentication