--- agentTools: projectIndex: https://onebrick.readme.io/llms.txt --- # Get Topup History This API enable you to check your current balance. Use this endpoint to retrieve top-up history and reconcile balance movements in your Brick account. The response includes top-up references, bank destination information, dates, amounts, and transaction metadata. Use it together with the balance endpoint to confirm whether a top-up has been reflected in your account. ## When to Use This Endpoint * Reconcile balance after a bank transfer top-up. * Display top-up activity in an internal dashboard. * Investigate missing or delayed balance movement. ## Filtering Use the optional `type` query parameter when you need to filter the response to top-up transactions only. ## Request parameters | Key Parameters | Data Type | Description | | :---------------- | :-------- | :------------------------------------------------------- | | publicAccessToken | String | One time access-token generated using the auth token API | ## Response parameters | Key Parameters | Data type | Description | | :----------------- | :-------- | :--------------------------------------------------- | | refNumber | String | Generate reference number for Top-up | | bank | Number | Top-up bank destination | | date | String | Date of Topup settle | | amount | String | The amount of Top-up | | transactionType | String | Indicate transactions, this api also show va & topup | | accountNo | String | Topu-p account number | | accountDisplayName | String | Account display name of Top-up account | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Payment v2", "version": "2" }, "servers": [ { "url": "https://sandbox.onebrick.io/v2/payments/gs" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "publicAccessToken", "x-default": "Bearer" } } }, "security": [ { "sec0": [] } ], "paths": { "/get-top-up-history": { "get": { "summary": "Get Topup History", "description": "This API enable you to check your current balance.", "operationId": "get-top-up-history", "parameters": [ { "name": "type", "in": "query", "description": "If type set as topup will filter only topup transactions", "schema": { "type": "string", "default": "topup" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"content\": [\n {\n \"topUpId\": \"1826064\",\n \"refNumber\": \"18485-a99f6ea8-3970-4782-87d9-e9ac1d9f4182\",\n \"bank\": \"BRI\",\n \"date\": \"2026-01-13T14:11:57.000+07:00\",\n \"amount\": 10000,\n \"transactionType\": \"Top-up\",\n \"accountNo\": \"1392400000000001\",\n \"accountDisplayName\": \"Brick PT QamiAwesome Ma\"\n },\n {\n \"topUpId\": \"1824998\",\n \"refNumber\": \"18485-a99f6ea8-3970-4782-87d9-e9ac1d9f4182\",\n \"bank\": \"BRI\",\n \"date\": \"2026-01-09T20:44:33.000+07:00\",\n \"amount\": 29999,\n \"transactionType\": \"Top-up\",\n \"accountNo\": \"1392400000000001\",\n \"accountDisplayName\": \"Brick PT QamiAwesome Ma\"\n },\n {\n \"topUpId\": \"1824993\",\n \"refNumber\": \"18485-a99f6ea8-3970-4782-87d9-e9ac1d9f4182\",\n \"bank\": \"BRI\",\n \"date\": \"2026-01-09T19:54:38.000+07:00\",\n \"amount\": 29999,\n \"transactionType\": \"Top-up\",\n \"accountNo\": \"1392400000000001\",\n \"accountDisplayName\": \"Brick PT QamiAwesome Ma\"\n },\n {\n \"topUpId\": \"106539\",\n \"refNumber\": \"PT 06012026140036\",\n \"bank\": \"BCA\",\n \"date\": \"2026-01-06T14:00:36.000+07:00\",\n \"amount\": 10957,\n \"transactionType\": \"Top-up\",\n \"accountNo\": \"\",\n \"accountDisplayName\": \"\"\n }\n ],\n \"pageCount\": 1,\n \"pageIndex\": 0,\n \"pageSize\": 10,\n \"perPage\": 10,\n \"totalElements\": 4\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"error\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "content": { "type": "array", "items": { "type": "object", "properties": { "topUpId": { "type": "string", "example": "1826064" }, "refNumber": { "type": "string", "example": "18485-a99f6ea8-3970-4782-87d9-e9ac1d9f4182" }, "bank": { "type": "string", "example": "BRI" }, "date": { "type": "string", "example": "2026-01-13T14:11:57.000+07:00" }, "amount": { "type": "integer", "example": 10000, "default": 0 }, "transactionType": { "type": "string", "example": "Top-up" }, "accountNo": { "type": "string", "example": "1392400000000001" }, "accountDisplayName": { "type": "string", "example": "Brick PT QamiAwesome Ma" } } } }, "pageCount": { "type": "integer", "example": 1, "default": 0 }, "pageIndex": { "type": "integer", "example": 0, "default": 0 }, "pageSize": { "type": "integer", "example": 10, "default": 0 }, "perPage": { "type": "integer", "example": 10, "default": 0 }, "totalElements": { "type": "integer", "example": 4, "default": 0 } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "invalid token": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Please use valid Public_access_token in headers\",\n \"action\": \"Please generate valid public access token via /v2/payments/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"Invalid public_access_token in headers\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_headers" }, "message": { "type": "string", "example": "Please use valid Public_access_token in headers" }, "action": { "type": "string", "example": "Please generate valid public access token via /v2/payments/auth/token APIs or contact to Brick sales team" }, "reason": { "type": "string", "example": "Invalid public_access_token in headers" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true, "_id": "62aa98669833aa0028c5a455:6971131c6bc368d34efe2351" } ```