{ "openapi": "3.1.0", "info": { "title": "Brick API", "version": "2", "description": "Referensi lengkap untuk titik akhir Brick API, autentikasi, skema permintaan, contoh pengujian, callbacks, dan penanganan respons di seluruh alur kerja Send Money, Receive Money, Financial Insight, dan ruang kerja. Gunakan Referensi API ini untuk memilih endpoint yang benar, menyiapkan header dan payload yang diperlukan, menguji permintaan sandbox, dan memahami URL produksi untuk setiap integrasi Brick." }, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Production Brick API" } ], "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic", "description": "Gunakan Brick Client ID sebagai username dan Client Secret sebagai password." }, "sec0": { "type": "apiKey", "in": "header", "name": "publicAccessToken", "description": "Gunakan token akses publik Brick berumur pendek yang dihasilkan dari Access Token endpoint. Sertakan awalan Pembawa bila diperlukan oleh endpoint.", "x-default": "Bearer" }, "sec1": { "type": "apiKey", "in": "header", "name": "X-Signature", "description": "B2C Subaccount tanda tangan permintaan dihasilkan dengan kunci pribadi yang dikonfigurasi." }, "sec2": { "type": "apiKey", "in": "header", "name": "X-Timestamp", "description": "Stempel waktu yang digunakan dalam permintaan B2C Subaccount yang ditandatangani." } } }, "paths": { "/v2/payments/general/client/public-key": { "post": { "summary": "[B2C Client] Setup Public Key", "description": "Unggah kunci publik yang harus digunakan Brick untuk mengenkripsi kredensial klien B2C yang dihasilkan untuk sub-akun. Hubungi ini sebelum membuat sub-akun B2C sehingga materi rahasia klien yang dikembalikan dapat ditangani dengan aman oleh platform Anda. Permintaan tersebut memerlukan header autentikasi Brick dan responsnya mengonfirmasi bahwa kunci enkripsi siap untuk penyediaan sub-akun berikutnya.", "operationId": "b2c-client-setup-public-key", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "publicKey": { "type": "string", "description": "File yang berisi Kunci publik Anda dalam format .pem. Ukuran maksimal 100KB.", "format": "binary" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": null,\n \"error\": null,\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": {}, "error": {}, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Type not supported": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Only public key file types are supported\",\n \"action\": \"Please uploade public key file types\",\n \"reason\": \"File type is not match with out system\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "File upload too large": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"file_too_large\",\n \"message\": \"Uploaded public key file exceeds the allowed size limit\",\n \"action\": \"Please upload an public key file less than 100KB\",\n \"reason\": \"File size exceeds configured maximum\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "Jenis tidak didukung", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Only public key file types are supported" }, "action": { "type": "string", "example": "Please uploade public key file types" }, "reason": { "type": "string", "example": "File type is not match with out system" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "Unggahan file terlalu besar", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "file_too_large" }, "message": { "type": "string", "example": "Uploaded public key file exceeds the allowed size limit" }, "action": { "type": "string", "example": "Please upload an public key file less than 100KB" }, "reason": { "type": "string", "example": "File size exceeds configured maximum" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 500,\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"Something went wrong on our side\",\n \"action\": \"Try again later or contact support if the issue persists\",\n \"reason\": \"Unexpected error in server process\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 500, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "server_error" }, "message": { "type": "string", "example": "Something went wrong on our side" }, "action": { "type": "string", "example": "Try again later or contact support if the issue persists" }, "reason": { "type": "string", "example": "Unexpected error in server process" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Subakun B2C" ], "x-docs-page": "/getting-started/subaccount-management/b2c-client-setup-public-key", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [], "sec1": [], "sec2": [] } ], "x-brick-endpoint-base-path": "/v2/payments/general", "x-brick-original-path": "/client/public-key" } }, "/v2/payments/general/b2c/sub-accounts": { "post": { "summary": "[B2C Client] Buat Subaccount", "description": "Buat sub-akun B2C di bawah ruang kerja Brick Anda untuk klien, penyewa, pedagang, atau unit bisnis. Kirim detail pelanggan dan akun yang diperlukan dengan header otentikasi B2C; Brick mengembalikan pengidentifikasi sub-akun dan kredensial terenkripsi yang dapat disimpan di platform Anda. Gunakan endpoint ini ketika Anda memerlukan pemisahan kredensial di seluruh pelanggan akhir sambil tetap menjaga kontrol operasional terpusat.", "operationId": "b2c-client-create-subaccount", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "subAccountCode", "email", "address" ], "properties": { "name": { "type": "string", "description": "Nama bisnis atau konsumen individu" }, "subAccountCode": { "type": "string", "description": "Kode alfanumerik unik (maks. 5 karakter) yang digunakan untuk mengidentifikasi sub-akun" }, "email": { "type": "string", "description": "Alamat email kontak untuk sub-akun" }, "address": { "type": "string", "description": "Alamat bisnis atau tempat tinggal yang terkait dengan sub-akun" }, "picture": { "type": "string", "description": "(Opsional) File gambar logo (maks. 2 MB) untuk mewakili sub-akun secara visual", "format": "binary" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"message\": \"Subaccount created successfully\",\n \"data\": {\n \"status\": \"approved\",\n \"apiKey\": {\n \"clientKey\": \"YOUR_CLIENT_ID\",\n \"clientSecret\": \"YOUR_CLIENT_SECRET\"\n }\n }\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please use valid and active accountNumber in request query\",\n \"action\": \"Please verify the account number in /v2/payments/bank-account-validation API\",\n \"reason\": \"accountNumber is invalid in request body\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "Image Upload Too Large": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"image_too_large\",\n \"message\": \"Uploaded image exceeds the allowed size limit.\",\n \"action\": \"Please upload an image file less than 2MB.\",\n \"reason\": \"File size exceeds configured maximum.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}\n" }, "Unauthorized": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"Authentication failed. Invalid or expired access token.\",\n \"action\": \"Re-authenticate and retry with a valid token.\",\n \"reason\": \"Bearer token is missing or invalid.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please use valid and active accountNumber in request query" }, "action": { "type": "string", "example": "Please verify the account number in /v2/payments/bank-account-validation API" }, "reason": { "type": "string", "example": "accountNumber is invalid in request body" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "Unggah Gambar Terlalu Besar", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "image_too_large" }, "message": { "type": "string", "example": "Uploaded image exceeds the allowed size limit." }, "action": { "type": "string", "example": "Please upload an image file less than 2MB." }, "reason": { "type": "string", "example": "File size exceeds configured maximum." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } }, { "title": "Tidak Terotorisasi", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "unauthorized" }, "message": { "type": "string", "example": "Authentication failed. Invalid or expired access token." }, "action": { "type": "string", "example": "Re-authenticate and retry with a valid token." }, "reason": { "type": "string", "example": "Bearer token is missing or invalid." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } ] } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": "{\n \"status\": 403,\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"You are not authorized to perform this action.\",\n \"action\": \"Ensure your account has the correct permissions (B2C role: main).\",\n \"reason\": \"Insufficient access scope or role.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 403, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "forbidden" }, "message": { "type": "string", "example": "You are not authorized to perform this action." }, "action": { "type": "string", "example": "Ensure your account has the correct permissions (B2C role: main)." }, "reason": { "type": "string", "example": "Insufficient access scope or role." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Subaccount Not Found": { "value": "{\n \"status\": 404,\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"The requested subaccount does not exist.\",\n \"action\": \"Verify the sub_account_code and try again.\",\n \"reason\": \"Subaccount not found in the database.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 404, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "not_found" }, "message": { "type": "string", "example": "The requested subaccount does not exist." }, "action": { "type": "string", "example": "Verify the sub_account_code and try again." }, "reason": { "type": "string", "example": "Subaccount not found in the database." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "409": { "description": "409", "content": { "application/json": { "examples": { "Duplicate Subaccount Code": { "value": "{\n \"status\": 409,\n \"error\": {\n \"code\": \"duplicate_code\",\n \"message\": \"Subaccount code is already registered.\",\n \"action\": \"Use a unique sub_account_code.\",\n \"reason\": \"Conflict with existing subaccount record.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 409, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "duplicate_code" }, "message": { "type": "string", "example": "Subaccount code is already registered." }, "action": { "type": "string", "example": "Use a unique sub_account_code." }, "reason": { "type": "string", "example": "Conflict with existing subaccount record." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "429": { "description": "429", "content": { "application/json": { "examples": { "Rate Limit Exceeded": { "value": "{\n \"status\": 429,\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"Too many requests. Please slow down.\",\n \"action\": \"Retry after 60 seconds or contact support to increase limit.\",\n \"reason\": \"Request limit exceeded for client.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 429, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "rate_limit_exceeded" }, "message": { "type": "string", "example": "Too many requests. Please slow down." }, "action": { "type": "string", "example": "Retry after 60 seconds or contact support to increase limit." }, "reason": { "type": "string", "example": "Request limit exceeded for client." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Internal Server Error": { "value": "{\n \"status\": 500,\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"Something went wrong on our side.\",\n \"action\": \"Try again later or contact support if the issue persists.\",\n \"reason\": \"Unexpected error in server process.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 500, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "server_error" }, "message": { "type": "string", "example": "Something went wrong on our side." }, "action": { "type": "string", "example": "Try again later or contact support if the issue persists." }, "reason": { "type": "string", "example": "Unexpected error in server process." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Subakun B2C" ], "x-docs-page": "/getting-started/subaccount-management/b2c-client-create-subaccount", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [], "sec1": [], "sec2": [] } ], "x-brick-endpoint-base-path": "/v2/payments/general", "x-brick-original-path": "/b2c/sub-accounts" } }, "/v2/payments/general/b2c/sub-accounts/{subAccountCode}/regenerate-api-key": { "post": { "summary": "[B2C Client] Regenerate API Key", "description": "Buat ulang pasangan kunci API untuk sub-akun B2C yang ada ketika kredensial perlu dirotasi, disusupi, atau diterbitkan ulang. Pasangan kunci sebelumnya tidak valid setelah regenerasi, jadi perbarui layanan downstream sebelum mengalihkan lalu lintas. Hanya peran pemilik B2C yang berwenang yang boleh menyebut ini endpoint, dan responsnya harus diperlakukan sebagai materi kredensial sensitif.", "operationId": "b2c-client-regenerate-api-key", "parameters": [ { "name": "subAccountCode", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"message\": \"API keys regenerated successfully\",\n \"data\": {\n \"apiKey\": {\n \"clientKey\": \"encrypted_new_client_key_xxx\",\n \"clientSecret\": \"encrypted_new_client_secret_xxx\"\n }\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "message": { "type": "string", "example": "API keys regenerated successfully" }, "data": { "type": "object", "properties": { "apiKey": { "type": "object", "properties": { "clientKey": { "type": "string", "example": "encrypted_new_client_key_xxx" }, "clientSecret": { "type": "string", "example": "encrypted_new_client_secret_xxx" } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_input\",\n \"message\": \"Request body is invalid or incomplete.\",\n \"action\": \"Check required fields and data types in the request body.\",\n \"reason\": \"Missing or malformed parameters.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" }, "Image Upload Too Large": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"image_too_large\",\n \"message\": \"Uploaded image exceeds the allowed size limit.\",\n \"action\": \"Please upload an image file less than 2MB.\",\n \"reason\": \"File size exceeds configured maximum.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_input" }, "message": { "type": "string", "example": "Request body is invalid or incomplete." }, "action": { "type": "string", "example": "Check required fields and data types in the request body." }, "reason": { "type": "string", "example": "Missing or malformed parameters." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } }, { "title": "Unggah Gambar Terlalu Besar", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "image_too_large" }, "message": { "type": "string", "example": "Uploaded image exceeds the allowed size limit." }, "action": { "type": "string", "example": "Please upload an image file less than 2MB." }, "reason": { "type": "string", "example": "File size exceeds configured maximum." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } ] } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"Authentication failed. Invalid or expired access token.\",\n \"action\": \"Re-authenticate and retry with a valid token.\",\n \"reason\": \"Bearer token is missing or invalid.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "unauthorized" }, "message": { "type": "string", "example": "Authentication failed. Invalid or expired access token." }, "action": { "type": "string", "example": "Re-authenticate and retry with a valid token." }, "reason": { "type": "string", "example": "Bearer token is missing or invalid." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Forbidden": { "value": "{\n \"status\": 403,\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"You are not authorized to perform this action.\",\n \"action\": \"Ensure your account has the correct permissions (B2C role: main).\",\n \"reason\": \"Insufficient access scope or role.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 403, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "forbidden" }, "message": { "type": "string", "example": "You are not authorized to perform this action." }, "action": { "type": "string", "example": "Ensure your account has the correct permissions (B2C role: main)." }, "reason": { "type": "string", "example": "Insufficient access scope or role." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Subaccount Not Found": { "value": "{\n \"status\": 404,\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"The requested subaccount does not exist.\",\n \"action\": \"Verify the sub_account_code and try again.\",\n \"reason\": \"Subaccount not found in the database.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 404, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "not_found" }, "message": { "type": "string", "example": "The requested subaccount does not exist." }, "action": { "type": "string", "example": "Verify the sub_account_code and try again." }, "reason": { "type": "string", "example": "Subaccount not found in the database." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "409": { "description": "409", "content": { "application/json": { "examples": { "Duplicate Subaccount Code": { "value": "{\n \"status\": 409,\n \"error\": {\n \"code\": \"duplicate_code\",\n \"message\": \"Subaccount code is already registered.\",\n \"action\": \"Use a unique sub_account_code.\",\n \"reason\": \"Conflict with existing subaccount record.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 409, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "duplicate_code" }, "message": { "type": "string", "example": "Subaccount code is already registered." }, "action": { "type": "string", "example": "Use a unique sub_account_code." }, "reason": { "type": "string", "example": "Conflict with existing subaccount record." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "429": { "description": "429", "content": { "application/json": { "examples": { "Rate Limit Exceeded": { "value": "{\n \"status\": 429,\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"Too many requests. Please slow down.\",\n \"action\": \"Retry after 60 seconds or contact support to increase limit.\",\n \"reason\": \"Request limit exceeded for client.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 429, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "rate_limit_exceeded" }, "message": { "type": "string", "example": "Too many requests. Please slow down." }, "action": { "type": "string", "example": "Retry after 60 seconds or contact support to increase limit." }, "reason": { "type": "string", "example": "Request limit exceeded for client." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Internal Server Error": { "value": "{\n \"status\": 500,\n \"error\": {\n \"code\": \"server_error\",\n \"message\": \"Something went wrong on our side.\",\n \"action\": \"Try again later or contact support if the issue persists.\",\n \"reason\": \"Unexpected error in server process.\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Subaccount\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 500, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "server_error" }, "message": { "type": "string", "example": "Something went wrong on our side." }, "action": { "type": "string", "example": "Try again later or contact support if the issue persists." }, "reason": { "type": "string", "example": "Unexpected error in server process." } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Subaccount" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Subakun B2C" ], "x-docs-page": "/getting-started/subaccount-management/b2c-client-regenerate-api-key", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [], "sec1": [], "sec2": [] } ], "x-brick-endpoint-base-path": "/v2/payments/general", "x-brick-original-path": "/b2c/sub-accounts/{subAccountCode}/regenerate-api-key" } }, "/v2/payments/auth/token": { "get": { "summary": "Access Token", "description": "Hasilkan token akses publik berumur pendek yang digunakan oleh sebagian besar permintaan Brick API. Otentikasi dengan Brick Client ID dan Client Secret Anda, lalu teruskan token yang dikembalikan di header publicAccessToken untuk pembayaran, pembayaran, QRIS, Virtual Account, Checkout, OCR, dan panggilan validasi. Segarkan token sebelum masa berlakunya habis dan jangan pernah mengekspos kredensial klien yang berumur panjang dalam kode frontend.", "operationId": "generate-public-access-token-jwt-token", "security": [ { "basicAuth": [] } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"error\": null,\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": {\n \"message\": \"Access token is valid for 5 minutes and can use one time only\",\n \"accessToken\": \"YOUR_ACCESS_TOKEN\",\n \"issuedAt\": \"2022-07-21T16:26:08.782387\",\n \"expiresAt\": \"2022-07-21T16:31:08.782387\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "error": {}, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "Access token is valid for 5 minutes and can use one time only" }, "accessToken": { "type": "string", "example": "YOUR_ACCESS_TOKEN" }, "issuedAt": { "type": "string", "example": "2022-07-21T16:26:08.782387" }, "expiresAt": { "type": "string", "example": "2022-07-21T16:31:08.782387" } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"missing_parameters_in_headers\",\n \"message\": \"Please use the APIs with Username in headers\",\n \"action\": \"Please get correct username from Brick dashboard or connect with Brick sales team\",\n \"reason\": \"Username is missing in headers\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"AUTH\"\n },\n \"data\": null\n}" }, "user not exist": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"user_not_exist\",\n \"message\": \"Please use correct credential\",\n \"action\": \"Please contact Brick sales team\",\n \"reason\": \"user is not exist\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "expired token": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"expired_parameters_in_headers\",\n \"message\": \"Please use live 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\": \"Public_access_token is expired\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, " re-used token": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"token_used_in_headers\",\n \"message\": \"Please use live 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\": \"Public_access_token is used\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "missing_parameters_in_headers" }, "message": { "type": "string", "example": "Please use the APIs with Username in headers" }, "action": { "type": "string", "example": "Please get correct username from Brick dashboard or connect with Brick sales team" }, "reason": { "type": "string", "example": "Username is missing in headers" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "AUTH" } } }, "data": {} } }, { "title": "pengguna tidak ada", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "user_not_exist" }, "message": { "type": "string", "example": "Please use correct credential" }, "action": { "type": "string", "example": "Please contact Brick sales team" }, "reason": { "type": "string", "example": "user is not exist" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "token kedaluwarsa", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "expired_parameters_in_headers" }, "message": { "type": "string", "example": "Please use live 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": "Public_access_token is expired" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": " token yang digunakan kembali", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "token_used_in_headers" }, "message": { "type": "string", "example": "Please use live 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": "Public_access_token is used" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } } }, "deprecated": false, "tags": [ "Autentikasi" ], "x-docs-page": "/getting-started/generate-public-access-token-jwt-token", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "x-brick-endpoint-base-path": "/v2/payments", "x-brick-original-path": "/auth/token" } }, "/v2/payments/gs/top-up/bank/list": { "get": { "summary": "Lihat Opsi Top Up yang Tersedia", "description": "Ambil opsi transfer bank yang tersedia untuk mengisi saldo Brick Anda. Gunakan endpoint ini sebelum mendanai alur kerja Send Money sehingga pengguna keuangan atau operasi mengetahui bank tujuan, nomor rekening, dan petunjuk penggunaan mana. Responsnya dapat ditampilkan di dasbor internal atau digunakan untuk memandu pendanaan saldo sebelum pembayaran batch.", "operationId": "get-list-of-available-top-up-options", "parameters": [ { "name": "email", "in": "query", "description": "Akun email perusahaan Anda terdaftar pada saat proses pendaftaran", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"vaListData\": [\n {\n \"bankName\": \"Bank BNI\",\n \"bankShortCode\": \"BNI\",\n \"vaNumber\": \"98819xxxxx\"\n },\n {\n \"bankName\": \"Bank BRI\",\n \"bankShortCode\": \"BRI\",\n \"vaNumber\": \"1005xxxxx\"\n },\n {\n \"bankName\": \"Bank CIMB Niaga\",\n \"bankShortCode\": \"CIMB_NIAGA\",\n \"vaNumber\": \"2309xxxxx\"\n },\n {\n \"bankName\": \"Bank Mandiri\",\n \"bankShortCode\": \"MANDIRI\",\n \"vaNumber\": \"8804xxxxx\"\n }\n ]\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": { "vaListData": { "type": "array", "items": { "type": "object", "properties": { "bankName": { "type": "string", "example": "Bank BNI" }, "bankShortCode": { "type": "string", "example": "BNI" }, "vaNumber": { "type": "string", "example": "98819xxxxx" } } } } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Please use valid publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token\",\n \"reason\": \"Invalid publicAccessToken in headers\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_headers" }, "message": { "type": "string", "example": "Please use valid publicAccessToken in headers" }, "action": { "type": "string", "example": "Please generate valid public access token" }, "reason": { "type": "string", "example": "Invalid publicAccessToken in headers" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Top Up" ], "x-docs-page": "/topup-balance/available-top-up-options", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/top-up/bank/list" } }, "/v2/payments/gs/get-top-up-history": { "get": { "summary": "Lihat Riwayat Top Up", "description": "Ambil catatan riwayat top-up untuk periode yang dipilih sehingga tim Anda dapat merekonsiliasi aktivitas pendanaan saldo. Gunakan respons untuk mencocokkan transfer bank, peristiwa pendanaan operasional, dan pergerakan saldo Brick. endpoint ini berguna untuk dashboard keuangan, pemeriksaan audit, dan investigasi pendukung ketika dana pencairan tidak sesuai harapan.", "operationId": "get-top-up-history", "parameters": [ { "name": "type", "in": "query", "description": "Jika type set as topup hanya akan memfilter transaksi topup saja", "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, "tags": [ "Top Up" ], "x-docs-page": "/topup-balance/topup-history", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/get-top-up-history" } }, "/v2/payments/gs/balance": { "get": { "summary": "Lihat Saldo API", "description": "Periksa saldo akun Brick terbaru yang tersedia sebelum membuat pembayaran atau menjalankan pekerjaan pencairan terjadwal. Gunakan endpoint ini sebagai pagar pembatas untuk mencegah kegagalan dana yang tidak mencukupi dan untuk menunjukkan dana operasional saat ini di alat internal. Responsnya harus diselaraskan dengan riwayat top-up dan catatan buku besar ketika menyelidiki perubahan saldo.", "operationId": "get-balance-api", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"balance\": {\n \"usableBalance\": 10099380255,\n \"pendingBalance\": 1000000,\n \"totalBalance\": 10100380255\n },\n \"sameDaySettlement\": {\n \"isActive\": true,\n \"earlySettlementBalanceQuota\": 500000\n }\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": { "balance": { "type": "object", "properties": { "usableBalance": { "type": "integer", "example": 10099380255, "default": 0 }, "pendingBalance": { "type": "integer", "example": 1000000, "default": 0 }, "totalBalance": { "type": "integer", "example": 10100380255, "default": 0 } } }, "sameDaySettlement": { "type": "object", "properties": { "isActive": { "type": "boolean", "example": true, "default": true }, "earlySettlementBalanceQuota": { "type": "integer", "example": 500000, "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}" }, "token is expired": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"expired_parameters_in_headers\",\n \"message\": \"Please use live publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/payments/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"publicAccessToken is expired\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "token tidak valid", "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": {} } }, { "title": "token sudah habis masa berlakunya", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "expired_parameters_in_headers" }, "message": { "type": "string", "example": "Please use live publicAccessToken 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": "publicAccessToken is expired" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } } }, "deprecated": false, "tags": [ "Saldo" ], "x-docs-page": "/topup-balance/balance-api", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/balance" } }, "/v2/payments/gs/bank-account-validation": { "get": { "summary": "API Verifikasi Rekening", "description": "Verifikasi detail rekening bank sebelum menyimpan penerima, melakukan orientasi pengguna, atau memulai pembayaran. Gunakan endpoint ini sebagai Financial Insight atau pemeriksaan pengendalian risiko untuk mengurangi kegagalan terkait kesalahan ketik dan penggunaan akun yang mencurigakan. Responsnya membantu sistem Anda memutuskan apakah data akun cukup valid untuk melanjutkan alur kerja.", "operationId": "account-verification-api", "parameters": [ { "name": "accountNumber", "in": "query", "description": "Nomor rekening bank yang akan diverifikasi.", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "bankShortCode", "in": "query", "description": "Kode pendek bank yang akan divalidasi. Contoh collection: MANDIRI.", "required": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "200 Sukses", "content": { "application/json": { "examples": { "Success": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We are successfully able to verify the account\",\n \"bankShortCode\": \"DANA\",\n \"accountNo\": \"08123412341234\",\n \"accountName\": \"beneficiary holder name\",\n \"activityId\": \"86569bbf0b017afb59cb71765eaec280\"\n },\n \"error\": null,\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n }\n}" } }, "schema": { "oneOf": [ { "title": "Success", "type": "object", "properties": { "status": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "We are successfully able to verify the account" }, "bankShortCode": { "type": "string", "example": "DANA" }, "accountNo": { "type": "string", "example": "08123412341234" }, "accountName": { "type": "string", "example": "beneficiary holder name" }, "activityId": { "type": "string", "example": "86569bbf0b017afb59cb71765eaec280" } } }, "error": { "nullable": true }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } }, { "title": "Error", "type": "object", "properties": { "status": { "type": "integer", "example": 400 }, "data": { "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_format" }, "message": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } } ] } } } }, "400": { "description": "400 Format tidak valid", "content": { "application/json": { "examples": { "Invalid format": { "value": "{\n \"status\": 400,\n \"data\": null,\n \"error\": {\n \"code\": \"invalid_format\",\n \"message\": \"The bank account validation request could not be processed because one or more submitted fields are missing, invalid, or not in the required format.\",\n \"action\": \"Please review the request parameters and ensure the account number, bank code, and other required fields follow the required format before submitting again.\",\n \"reason\": \"The request contains invalid, incomplete, or improperly formatted information required to process the bank account validation.\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n }\n}" } }, "schema": { "oneOf": [ { "title": "Success", "type": "object", "properties": { "status": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "We are successfully able to verify the account" }, "bankShortCode": { "type": "string", "example": "DANA" }, "accountNo": { "type": "string", "example": "08123412341234" }, "accountName": { "type": "string", "example": "beneficiary holder name" }, "activityId": { "type": "string", "example": "86569bbf0b017afb59cb71765eaec280" } } }, "error": { "nullable": true }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } }, { "title": "Error", "type": "object", "properties": { "status": { "type": "integer", "example": 400 }, "data": { "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_format" }, "message": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } } ] } } } }, "404": { "description": "404 Akun tidak ditemukan", "content": { "application/json": { "examples": { "Account not found": { "value": "{\n \"status\": 404,\n \"data\": null,\n \"error\": {\n \"code\": \"account_not_found\",\n \"message\": \"We were unable to verify the submitted bank account details. The account number, account holder name, or bank information may be incorrect or not available for validation.\",\n \"action\": \"Please review the account number, account holder name, and bank details, then submit the request again with the correct information.\",\n \"reason\": \"The provider could not find a matching bank account or account holder based on the submitted validation details.\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n }\n}" } }, "schema": { "oneOf": [ { "title": "Success", "type": "object", "properties": { "status": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "We are successfully able to verify the account" }, "bankShortCode": { "type": "string", "example": "DANA" }, "accountNo": { "type": "string", "example": "08123412341234" }, "accountName": { "type": "string", "example": "beneficiary holder name" }, "activityId": { "type": "string", "example": "86569bbf0b017afb59cb71765eaec280" } } }, "error": { "nullable": true }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } }, { "title": "Error", "type": "object", "properties": { "status": { "type": "integer", "example": 400 }, "data": { "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_format" }, "message": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } } ] } } } }, "500": { "description": "500 Kesalahan server internal", "content": { "application/json": { "examples": { "Internal server error": { "value": "{\n \"status\": 500,\n \"data\": null,\n \"error\": {\n \"code\": \"INTERNAL_SERVER_ERROR\",\n \"message\": \"Bank account validation could not be completed at this time due to a temporary processing issue from the downstream bank network, or internal validation service.\",\n \"action\": \"Please retry the request later. If the issue persists, please contact support with the transaction reference for further assistance.\",\n \"reason\": \"The validation request could not be completed because a temporary system or bank network error occurred during processing.\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n }\n}" } }, "schema": { "oneOf": [ { "title": "Success", "type": "object", "properties": { "status": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "We are successfully able to verify the account" }, "bankShortCode": { "type": "string", "example": "DANA" }, "accountNo": { "type": "string", "example": "08123412341234" }, "accountName": { "type": "string", "example": "beneficiary holder name" }, "activityId": { "type": "string", "example": "86569bbf0b017afb59cb71765eaec280" } } }, "error": { "nullable": true }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } }, { "title": "Error", "type": "object", "properties": { "status": { "type": "integer", "example": 400 }, "data": { "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_format" }, "message": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } } ] } } } }, "503": { "description": "503 Perilaku tidak diketahui", "content": { "application/json": { "examples": { "Unknown behaviour": { "value": "{\n \"status\": 503,\n \"data\": null,\n \"error\": {\n \"code\": \"UNKNOWN_BEHAVIOUR\",\n \"message\": \"Bank account validation could not be completed because the bank network returned an unexpected response that could not be met with a standard validation result.\",\n \"action\": \"Please retry the request later. If the issue persists, please contact support with the transaction reference for further investigation.\",\n \"reason\": \"The provider returned an unmapped, unexpected, or unsupported response that could not be classified under the standard validation outcome.\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n }\n}" } }, "schema": { "oneOf": [ { "title": "Success", "type": "object", "properties": { "status": { "type": "integer", "example": 200 }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "We are successfully able to verify the account" }, "bankShortCode": { "type": "string", "example": "DANA" }, "accountNo": { "type": "string", "example": "08123412341234" }, "accountName": { "type": "string", "example": "beneficiary holder name" }, "activityId": { "type": "string", "example": "86569bbf0b017afb59cb71765eaec280" } } }, "error": { "nullable": true }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } }, { "title": "Error", "type": "object", "properties": { "status": { "type": "integer", "example": 400 }, "data": { "nullable": true }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_format" }, "message": { "type": "string" }, "action": { "type": "string" }, "reason": { "type": "string" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } } ] } } } } }, "deprecated": false, "tags": [ "Validasi Rekening Bank" ], "x-docs-page": "/brickdata/bank-account-validation/account-verification-api", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/bank-account-validation" } }, "/v2/payments/gs/bifast-disbursements": { "post": { "summary": "API Disbursement BI-FAST", "description": "Buat pencairan BI-FAST untuk pembayaran bank hampir real-time melalui Brick Send Money. Memberikan jumlah, reference ID, rincian bank penerima, informasi pengirim, dan header otentikasi yang diperlukan; Brick mengembalikan catatan pencairan dan memproses transfer secara asinkron. Gunakan callbacks dan titik akhir penyelidikan status untuk merekonsiliasi status pembayaran akhir setelah penyerahan.", "operationId": "disbursement-bifast", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "referenceId", "description", "disbursementMethod", "sender" ], "properties": { "amount": { "type": "integer", "description": "Jumlah yang ingin Anda kirim", "default": 10000, "format": "int32" }, "referenceId": { "type": "string", "description": "reference ID unik sebagai pengidentifikasi unik", "default": "test-1" }, "description": { "type": "string", "description": "String sembarang yang melekat pada objek. Seringkali berguna untuk menampilkan kepada pengguna tujuan transaksi tersebut. Batas panjang deskripsi adalah 1000 karakter.", "default": "test-disbursement-1" }, "disbursementMethod": { "type": "object", "required": [ "type", "bankAccountNo", "bankShortCode", "bankAccountHolderName" ], "properties": { "type": { "type": "string", "default": "bank_transfer" }, "bankAccountNo": { "type": "string", "default": "010800041187" }, "bankShortCode": { "type": "string", "default": "BCA" }, "bankAccountHolderName": { "type": "string", "default": "JOHN CENA" } } }, "sender": { "type": "object", "required": [ "name", "identityType", "identityNumber", "countryCode", "provinceCode", "cityCode", "jobCode", "address", "placeOfBirth", "dateOfBirth" ], "properties": { "name": { "type": "string", "description": "Nama pengguna yang mentransfer", "default": "Jaya Teguh" }, "identityType": { "type": "string", "description": "Nilai yang Diizinkan hanya KTP/SIM/KITAS/NPWP", "default": "KTP" }, "identityNumber": { "type": "string", "description": "Nomor Identitas Pengguna", "default": "3276022410110004" }, "countryCode": { "type": "string", "description": "Kode negara dua huruf untuk pengirim", "default": "ID" }, "provinceCode": { "type": "string", "description": "Kode provinsi dua huruf untuk pengirim", "default": "35" }, "cityCode": { "type": "string", "description": "Kode kota empat huruf untuk pengirim", "default": "1226" }, "jobCode": { "type": "string", "description": "Kode pekerjaan empat huruf untuk pengirim", "default": "89" }, "address": { "type": "string", "description": "Alamat pengirim", "default": "Tulodong Bawah No 4" }, "placeOfBirth": { "type": "string", "description": "Tempat Lahir Pengirim", "default": "Jakarta" }, "dateOfBirth": { "type": "string", "default": "1999-10-24", "format": "date" } } } } }, "examples": { "Request Example": { "value": { "amount": 50000, "referenceId": "demo-{{var}}", "description": "test-l", "disbursementMethod": { "type": "bank_transfer", "bankAccountNo": "000123456789", "bankShortCode": "PERMATA", "bankAccountHolderName": "Example Customer" }, "sender": { "name": "Example Customer", "identityType": "KTP", "identityNumber": "000123456789", "countryCode": "ID", "provinceCode": "75", "cityCode": "3205", "jobCode": "3", "address": "Example Address", "placeOfBirth": "Bali", "dateOfBirth": "1854-12-30" } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"message\": \"We have received your request and are processing it, please check your callback URL for transaction status\",\n \"id\": \"example-disbursement-id\",\n \"type\": \"disbursement\",\n \"attributes\": {\n \"referenceId\": \"reference-id-from-your-system\",\n \"description\": \"reference-id-from-your-system\",\n \"amount\": \"10000\",\n \"feeAmount\": \"600\",\n \"status\": \"processing\",\n \"settlementStatus\": \"null\",\n \"createdAt\": \"2022-07-21T13:49:39.752+07:00\",\n \"disbursementMethod\": {\n \"type\": \"bank_transfer\",\n \"bankAccountNo\": \"000123456789\",\n \"bankShortCode\": \"BCA\",\n \"bankAccountHolderName\": \"Example Customer\"\n },\n \"sender\": {\n \"name\": \"Example Customer\",\n \"identityType\": \"KTP\",\n \"identityNumber\": \"000123456789\",\n \"countryCode\": \"ID\",\n \"provinceCode\": \"35\",\n \"cityCode\": \"1226\",\n \"jobCode\": \"89\",\n \"address\": \"Example Address\",\n \"placeOfBirth\": \"Jakarta\",\n \"dateOfBirth\": \"1998-04-23\"\n }\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 }, "message": { "type": "string", "example": "We have received your request and are processing it, please check your callback URL for transaction status" }, "id": { "type": "string", "example": "asdasd123123asdasdasd" }, "type": { "type": "string", "example": "disbursement" }, "attributes": { "type": "object", "properties": { "referenceId": { "type": "string", "example": "test-disbursement-1" }, "description": { "type": "string", "example": "test-disbursement-1" }, "amount": { "type": "string", "example": "10000" }, "feeAmount": { "type": "string", "example": "600" }, "status": { "type": "string", "example": "processing" }, "settlementStatus": { "type": "string", "example": "null" }, "createdAt": { "type": "string", "example": "2022-07-21T13:49:39.752+07:00" }, "disbursementMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "bank_transfer" }, "bankAccountNo": { "type": "string", "example": "000123456789" }, "bankShortCode": { "type": "string", "example": "BCA" }, "bankAccountHolderName": { "type": "string", "example": "Example Customer" } } }, "sender": { "type": "object", "properties": { "name": { "type": "string", "example": "Example Customer" }, "identityType": { "type": "string", "example": "KTP" }, "identityNumber": { "type": "string", "example": "000123456789" }, "countryCode": { "type": "string", "example": "ID" }, "provinceCode": { "type": "string", "example": "35" }, "cityCode": { "type": "string", "example": "1226" }, "jobCode": { "type": "string", "example": "89" }, "address": { "type": "string", "example": "Example Address" }, "placeOfBirth": { "type": "string", "example": "Jakarta" }, "dateOfBirth": { "type": "string", "example": "1998-04-23" } } } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid transfer amount": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please use amount more than minimum transfer limit, ie:10.000\",\n \"action\": \"Please make sure the amount you requested is in the range of Rp 10.000 to Rp 100.000.000\",\n \"reason\": \"Your amount of transfer is below our minimum transfer amount\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "bankShortCode invalid": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please use valid bankShortCode in the request query\",\n \"action\": \"Please revalidate your bank short code https://docs.onebrick.io/brickfast-disbursement/api/list-of-bank-coverage\",\n \"reason\": \"bankShortCode is not valid in the request query\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "callback not available": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"session_available_in_other_device\",\n \"message\": \"Callback URL is not available\",\n \"action\": \"Please add the callback URL from dashboard or contact contact sales team\",\n \"reason\": \"This is Async API, Final response will be sended over callback URL\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "referenceId already used": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please make sure your External key (reference id) has never been used before\",\n \"action\": \"Please make sure to always use unique reference ID in the parameter\",\n \"reason\": \"Your external id (referenceId) has already been taken\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "Jumlah transfer tidak valid", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please use amount more than minimum transfer limit, ie:10.000" }, "action": { "type": "string", "example": "Please make sure the amount you requested is in the range of Rp 10.000 to Rp 100.000.000" }, "reason": { "type": "string", "example": "Your amount of transfer is below our minimum transfer amount" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "bankShortCode tidak valid", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please use valid bankShortCode in the request query" }, "action": { "type": "string", "example": "Please revalidate your bank short code https://docs.onebrick.io/brickfast-disbursement/api/list-of-bank-coverage" }, "reason": { "type": "string", "example": "bankShortCode is not valid in the request query" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "callback tidak tersedia", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "session_available_in_other_device" }, "message": { "type": "string", "example": "Callback URL is not available" }, "action": { "type": "string", "example": "Please add the callback URL from dashboard or contact contact sales team" }, "reason": { "type": "string", "example": "This is Async API, Final response will be sended over callback URL" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "referenceId sudah digunakan", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please make sure your External key (reference id) has never been used before" }, "action": { "type": "string", "example": "Please make sure to always use unique reference ID in the parameter" }, "reason": { "type": "string", "example": "Your external id (referenceId) has already been taken" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } }, "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}" }, "insufficient balance": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please make sure you have sufficient fund to process this transaction\",\n \"action\": \"Please do the top up to proceed this transactions\",\n \"reason\": \"Your Account has insufficient funds to process this transaction\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "Token tidak valid", "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": {} } }, { "title": "saldo tidak mencukupi", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please make sure you have sufficient fund to process this transaction" }, "action": { "type": "string", "example": "Please do the top up to proceed this transactions" }, "reason": { "type": "string", "example": "Your Account has insufficient funds to process this transaction" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\":500,\n \"data\":null,\n\t\"error\":\n \t{\n\t\t\t\"code\":\"service_unavailable\",\n \t\"message\":\"We are facing some problem in service, Please try again\",\n \t\"action\":\"Please wait and retry again\",\n \t\"reason\":\"Service is not available\"\n\t\t},\n \"metaData\":\n\t\t{\n \t\"source\":\"API\",\n \"entity\":\"Payment\"\n \t}\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 500, "default": 0 }, "data": {}, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "service_unavailable" }, "message": { "type": "string", "example": "We are facing some problem in service, Please try again" }, "action": { "type": "string", "example": "Please wait and retry again" }, "reason": { "type": "string", "example": "Service is not available" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } } } } }, "503": { "description": "503", "content": { "application/json": { "examples": { "Bank under maintenance": { "value": "{\n \"status\": 503,\n \"error\": {\n \"code\": \"Destination_under_maintenance\",\n \"message\": \"The destination is currently under maintenance\",\n \"action\": \"Please try again later\",\n \"reason\": \"Temporary downtime for the destination bank\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 503, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "Destination_under_maintenance" }, "message": { "type": "string", "example": "The destination is currently under maintenance" }, "action": { "type": "string", "example": "Please try again later" }, "reason": { "type": "string", "example": "Temporary downtime for the destination bank" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Disbursement BI-FAST" ], "x-docs-page": "/brickfast-disbursement/api/bifast-disbursement", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/bifast-disbursements" } }, "/v2/payments/gs/disbursements": { "post": { "summary": "Disbursement Reguler", "description": "Buat pencairan rutin ke rekening bank atau tujuan Ewallet yang didukung. Gunakan endpoint ini untuk alur kerja pembayaran standar yang mana BI-FAST tidak diperlukan, tidak tersedia, atau tidak dipilih oleh aturan perutean Anda. Kirimkan reference ID unik dan detail penerima, lalu rekonsiliasi penyelesaian melalui callbacks, catatan buku besar, atau titik akhir status pencairan.", "operationId": "disbursement-regular", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "referenceId", "description", "amount", "disbursementMethod" ], "properties": { "referenceId": { "type": "string", "description": "reference ID unik sebagai pengidentifikasi unik", "default": "test-1" }, "description": { "type": "string", "description": "String sembarang yang melekat pada objek. Seringkali berguna untuk menampilkan kepada pengguna tujuan transaksi tersebut. Batas panjang deskripsi adalah 1000 karakter.", "default": "test-disbursement-1" }, "amount": { "type": "integer", "description": "Jumlah yang ingin Anda kirim", "default": 29999, "format": "int32" }, "disbursementMethod": { "type": "object", "properties": { "type": { "type": "string", "default": "bank_transfer" }, "bankAccountNo": { "type": "string", "default": "000123456789" }, "bankShortCode": { "type": "string", "default": "MANDIRI" }, "bankAccountHolderName": { "type": "string", "default": "Example Customer" } } }, "recipientEmail": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have received your request and are processing it, please check your callback URL for transaction status\",\n \"id\": \"example-disbursement-id\",\n \"type\": \"disbursement\",\n \"attributes\": {\n \"referenceId\": \"reference-id-from-your-system\",\n \"description\": \"reference-id-from-your-system\",\n \"amount\": \"100000\",\n \"feeAmount\": \"2000\",\n \"status\": \"processing\",\n \"settlementStatus\": \"null\",\n \"createdAt\": \"2022-07-21T13:49:39.752+07:00\",\n \"disbursementMethod\": {\n \"type\": \"bank_transfer\",\n \"bankAccountNo\": \"000123456789\",\n \"bankShortCode\": \"BCA\",\n \"bankAccountHolderName\": \"Example Customer\"\n }\n }\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"error\": null\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid transfer amount": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please use amount more than minimum transfer limit, ie:10.000\",\n \"action\": \"Please make sure the amount you requested is in the range of Rp 10.000 to Rp 100.000.000\",\n \"reason\": \"Your amount of transfer is below our minimum transfer amount\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "bankShortCode invalid": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please use valid bankShortCode in the request query\",\n \"action\": \"Please revalidate your bank short code https://docs.onebrick.io/brickfast-disbursement/api/list-of-bank-coverage\",\n \"reason\": \"bankShortCode is not valid in the request query\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "callback not available": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"session_available_in_other_device\",\n \"message\": \"Callback URL is not available\",\n \"action\": \"Please add the callback URL from dashboard or contact contact sales team\",\n \"reason\": \"This is Async API, Final response will be sended over callback URL\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "referenceId already used": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please make sure your External key (reference id) has never been used before\",\n \"action\": \"Please make sure to always use unique reference ID in the parameter\",\n \"reason\": \"Your external id (referenceId) has already been taken\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "Jumlah transfer tidak valid", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please use amount more than minimum transfer limit, ie:10.000" }, "action": { "type": "string", "example": "Please make sure the amount you requested is in the range of Rp 10.000 to Rp 100.000.000" }, "reason": { "type": "string", "example": "Your amount of transfer is below our minimum transfer amount" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "bankShortCode tidak valid", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please use valid bankShortCode in the request query" }, "action": { "type": "string", "example": "Please revalidate your bank short code https://docs.onebrick.io/brickfast-disbursement/api/list-of-bank-coverage" }, "reason": { "type": "string", "example": "bankShortCode is not valid in the request query" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "callback tidak tersedia", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "session_available_in_other_device" }, "message": { "type": "string", "example": "Callback URL is not available" }, "action": { "type": "string", "example": "Please add the callback URL from dashboard or contact contact sales team" }, "reason": { "type": "string", "example": "This is Async API, Final response will be sended over callback URL" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "referenceId sudah digunakan", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please make sure your External key (reference id) has never been used before" }, "action": { "type": "string", "example": "Please make sure to always use unique reference ID in the parameter" }, "reason": { "type": "string", "example": "Your external id (referenceId) has already been taken" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } }, "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}" }, "insufficient balance": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please make sure you have sufficient fund to process this transaction\",\n \"action\": \"Please do the top up to proceed this transactions\",\n \"reason\": \"Your Account has insufficient funds to process this transaction\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "Token tidak valid", "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": {} } }, { "title": "saldo tidak mencukupi", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please make sure you have sufficient fund to process this transaction" }, "action": { "type": "string", "example": "Please do the top up to proceed this transactions" }, "reason": { "type": "string", "example": "Your Account has insufficient funds to process this transaction" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\":500,\n \"data\":null,\n\t\"error\":\n \t{\n\t\t\t\"code\":\"service_unavailable\",\n \t\"message\":\"We are facing some problem in service, Please try again\",\n \t\"action\":\"Please wait and retry again\",\n \t\"reason\":\"Service is not available\"\n\t\t},\n \"metaData\":\n\t\t{\n \t\"source\":\"API\",\n \"entity\":\"Payment\"\n \t}\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 500, "default": 0 }, "data": {}, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "service_unavailable" }, "message": { "type": "string", "example": "We are facing some problem in service, Please try again" }, "action": { "type": "string", "example": "Please wait and retry again" }, "reason": { "type": "string", "example": "Service is not available" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } } } } } } }, "503": { "description": "503", "content": { "application/json": { "examples": { "Bank under maintenance": { "value": "{\n \"status\": 503,\n \"error\": {\n \"code\": \"Destination_under_maintenance\",\n \"message\": \"The destination is currently under maintenance\",\n \"action\": \"Please try again later\",\n \"reason\": \"Temporary downtime for the destination bank\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 503, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "Destination_under_maintenance" }, "message": { "type": "string", "example": "The destination is currently under maintenance" }, "action": { "type": "string", "example": "Please try again later" }, "reason": { "type": "string", "example": "Temporary downtime for the destination bank" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Disbursement Reguler" ], "x-docs-page": "/brickfast-disbursement/api/regular-disbursement", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/disbursements" } }, "/v2/payments/gs/disbursements/{disbursementId}": { "get": { "summary": "Cek Status Disbursement dengan Disbursement ID", "description": "Ambil status pencairan terbaru dengan Brick pencairan ID. Gunakan endpoint ini setelah membuat pembayaran Reguler atau BI-FAST ketika sistem Anda telah menyimpan pengidentifikasi pencairan yang dihasilkan Brick. Respons ini membantu sistem dukungan, operasi, dan rekonsiliasi mengonfirmasi apakah pembayaran sedang diproses, diselesaikan, gagal, atau memerlukan penyelidikan lebih lanjut.", "operationId": "check-disbursement-status-using-reference-id", "parameters": [ { "name": "disbursementId", "in": "path", "description": "Disbursement ID transaksi", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have successfuly retrieve your disbursement\",\n \"id\": \"c8836b555a8842b2ac20fef1a\",\n \"type\": \"disbursement\",\n \"attributes\": {\n \"referenceId\": \"182y1841\",\n \"description\": \"Disbursement\",\n \"amount\": \"29999\",\n \"status\": \"failed\",\n \"createdAt\": \"2030-12-22T10:12:08.000+07:00\",\n \"disbursementMethod\": {\n \"type\": \"bank_transfer\",\n \"bankAccountNo\": \"78472\",\n \"bankShortCode\": \"MANDIRI\",\n \"bankAccountHolderName\": \"Test\",\n \"bankName\": \"Bank Mandiri\"\n },\n \"errorCode\": \"\",\n \"errorReason\": \"\"\n }\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": { "message": { "type": "string", "example": "We have successfuly retrieve your disbursement" }, "id": { "type": "string", "example": "c8836b555a8842b2ac20fef1a" }, "type": { "type": "string", "example": "disbursement" }, "attributes": { "type": "object", "properties": { "referenceId": { "type": "string", "example": "182y1841" }, "description": { "type": "string", "example": "Disbursement" }, "amount": { "type": "string", "example": "29999" }, "status": { "type": "string", "example": "failed" }, "createdAt": { "type": "string", "example": "2030-12-22T10:12:08.000+07:00" }, "disbursementMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "bank_transfer" }, "bankAccountNo": { "type": "string", "example": "78472" }, "bankShortCode": { "type": "string", "example": "MANDIRI" }, "bankAccountHolderName": { "type": "string", "example": "Test" }, "bankName": { "type": "string", "example": "Bank Mandiri" } } }, "errorCode": { "type": "string", "example": "" }, "errorReason": { "type": "string", "example": "" } } } } }, "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, "tags": [ "Disbursement" ], "x-docs-page": "/brickfast-disbursement/api/check-status-by-disbursement-id", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/disbursements/{disbursementId}" } }, "/v2/payments/gs/disbursements/transaction": { "get": { "summary": "Cek Status Disbursement dengan Reference ID", "description": "Ambil status pencairan terbaru berdasarkan reference ID yang disediakan klien Anda. Gunakan endpoint ini ketika pesanan internal, kumpulan pembayaran, atau kasus dukungan dikunci oleh referensi Anda sendiri, bukan Brick pencairan ID. Responsnya menghubungkan transaksi bisnis Anda ke status pembayaran Brick untuk rekonsiliasi dan komunikasi pelanggan.", "operationId": "retrieve-disbursement-using", "parameters": [ { "name": "referenceId", "in": "query", "description": "Reference ID dari yang diberikan dari Sisi Klien", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have successfuly retrieve your disbursement\",\n \"id\": \"c8836b555a8842b2ac20fef1a\",\n \"type\": \"disbursement\",\n \"attributes\": {\n \"referenceId\": \"182y1841\",\n \"description\": \"Disbursement\",\n \"amount\": \"29999\",\n \"status\": \"failed\",\n \"createdAt\": \"2030-12-22T10:12:08.000+07:00\",\n \"disbursementMethod\": {\n \"type\": \"bank_transfer\",\n \"bankAccountNo\": \"78472\",\n \"bankShortCode\": \"MANDIRI\",\n \"bankAccountHolderName\": \"Test\",\n \"bankName\": \"Bank Mandiri\"\n },\n \"errorCode\": \"\",\n \"errorReason\": \"\"\n }\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": { "message": { "type": "string", "example": "We have successfuly retrieve your disbursement" }, "id": { "type": "string", "example": "c8836b555a8842b2ac20fef1a" }, "type": { "type": "string", "example": "disbursement" }, "attributes": { "type": "object", "properties": { "referenceId": { "type": "string", "example": "182y1841" }, "description": { "type": "string", "example": "Disbursement" }, "amount": { "type": "string", "example": "29999" }, "status": { "type": "string", "example": "failed" }, "createdAt": { "type": "string", "example": "2030-12-22T10:12:08.000+07:00" }, "disbursementMethod": { "type": "object", "properties": { "type": { "type": "string", "example": "bank_transfer" }, "bankAccountNo": { "type": "string", "example": "78472" }, "bankShortCode": { "type": "string", "example": "MANDIRI" }, "bankAccountHolderName": { "type": "string", "example": "Test" }, "bankName": { "type": "string", "example": "Bank Mandiri" } } }, "errorCode": { "type": "string", "example": "" }, "errorReason": { "type": "string", "example": "" } } } } }, "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, "tags": [ "Disbursement" ], "x-docs-page": "/brickfast-disbursement/api/check-status-by-reference-id", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/disbursements/transaction" } }, "/v2/payments/gs/ledger": { "get": { "summary": "Ledger / Riwayat Disbursement", "description": "Ambil catatan buku besar untuk tanggal atau interval waktu yang dipilih untuk merekonsiliasi transaksi Brick hampir secara real-time. Gunakan endpoint ini untuk membandingkan pencairan, top-up, penyelesaian, dan pergerakan saldo operasional dengan catatan keuangan internal Anda. Respons ini ditujukan untuk dasbor keuangan, akuntansi ekspor, dan investigasi transaksi.", "operationId": "ledger-api", "parameters": [ { "name": "startDate", "in": "query", "description": "Sejak kapan transaksi harus diambil. Formatnya adalah YYYY-MM-DD", "schema": { "type": "string", "format": "date" } }, { "name": "endDate", "in": "query", "description": "Sampai kapan transaksi harus diambil. formatnya adalah YYYY-MM-DD", "schema": { "type": "string", "format": "date" } }, { "name": "status", "in": "query", "description": "Status transaksi. baik selesai atau diproses atau tertunda atau gagal. selalu huruf kecil", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Cari transaksi tertentu ID atau referenceId", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Halaman data mana yang harus diambil", "schema": { "type": "integer", "format": "int32" } }, { "name": "size", "in": "query", "description": "berapa banyak catatan yang perlu diambil per halaman. Catatan maksimum adalah 2000 & defaultnya adalah 100 per halaman", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We are successfully able to get the data\",\n \"transactions\": [\n {\n \"refId\": \"ref-1\",\n \"date\": \"2022-10-03T15:17:44.000+07:00\",\n \"accountHolderName\": \"test-123\",\n \"accountNumber\": \"12345678\",\n \"bankName\": \"Bank Artos Indonesia\",\n \"description\": \"Demo-1\",\n \"amount\": 20000,\n \"fees\": 4500,\n \"status\": \"completed\"\n },{\n \"refId\": \"ref-id123\",\n \"date\": \"2022-11-03T15:17:44.000+07:00\",\n \"accountHolderName\": \"test-123\",\n \"accountNumber\": \"12345678\",\n \"bankName\": \"Bank Artos Indonesia\",\n \"description\": \"Demo-2\",\n \"amount\": 20000,\n \"fees\": 4500,\n \"status\": \"completed\"\n }\n ]\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": { "message": { "type": "string", "example": "We are successfully able to get the data" }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "refId": { "type": "string", "example": "ref-1" }, "date": { "type": "string", "example": "2022-10-03T15:17:44.000+07:00" }, "accountHolderName": { "type": "string", "example": "test-123" }, "accountNumber": { "type": "string", "example": "12345678" }, "bankName": { "type": "string", "example": "Bank Artos Indonesia" }, "description": { "type": "string", "example": "Demo-1" }, "amount": { "type": "integer", "example": 20000, "default": 0 }, "fees": { "type": "integer", "example": 4500, "default": 0 }, "status": { "type": "string", "example": "completed" } } } } } }, "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, "tags": [ "Ledger" ], "x-docs-page": "/brickfast-disbursement/api/ledger-disbursement-history", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/ledger" } }, "/v2/payments/gs/disbursements/proof/{disbId}/download": { "get": { "summary": "API Unduh Bukti Transfer", "description": "Unduh dokumen bukti transfer untuk pencairan ketika Anda memerlukan bukti bahwa pembayaran telah diproses. Gunakan endpoint ini untuk dukungan pelanggan, jalur audit, pelaporan pedagang, dan dokumentasi keuangan. Permintaan dibatasi tarifnya, jadi simpanlah file bukti dalam cache dan hindari panggilan berulang untuk pencairan yang sama.", "operationId": "download-transfer-proof-api", "parameters": [ { "name": "disbId", "in": "path", "description": "Id Disbursement", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"Transfer proof has been successfully sent\"\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": { "message": { "type": "string", "example": "Transfer proof has been successfully sent" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": { "nullable": true } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Result": { "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": {} } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 404,\n \"error\": {\n \"code\": \"disbursement_not_found\",\n \"message\": \"Please use the API with valid Reference_id in the request query\",\n \"action\": \"Please read the docs to understand more or contact to Brick sales team\",\n \"reason\": \"disbursement not found\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 404, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "disbursement_not_found" }, "message": { "type": "string", "example": "Please use the API with valid Reference_id in the request query" }, "action": { "type": "string", "example": "Please read the docs to understand more or contact to Brick sales team" }, "reason": { "type": "string", "example": "disbursement not found" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Bukti Transfer" ], "x-docs-page": "/brickfast-disbursement/transfer-proof/download-transfer-proof-api", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/disbursements/proof/{disbId}/download" } }, "/v2/payments/gs/va/open": { "post": { "summary": "Generate Open VA", "description": "Hasilkan Open Virtual Account yang dapat menerima jumlah pembayaran fleksibel dari pelanggan. Gunakan Open VA ketika pembayar dapat mentransfer jumlah yang bervariasi ke pengidentifikasi VA yang sama, seperti isi ulang dompet atau aliran pendanaan akun yang dapat digunakan kembali. Simpan detail VA yang dikembalikan oleh Brick dan rekonsiliasi pembayaran melalui callbacks atau status Open VA endpoint.", "operationId": "generate-open-va", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "bankShortCode", "referenceId", "displayName" ], "properties": { "bankShortCode": { "type": "string", "description": "Kode pendek institusi bank", "default": "MANDIRI" }, "referenceId": { "type": "string", "description": "ID unik yang dihasilkan oleh klien untuk melacak setiap generasi VA (maksimum 255 karakter)", "default": "test-VA-1" }, "displayName": { "type": "string", "description": "Nama tampilan yang ditampilkan di platform pembayaran pelanggan (maksimum 24 karakter).", "default": "PRODONLY" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n\t\t\t\t\"message\": \"We have successfully generated the open VA\",\n \"id\": \"OP_SA123212SDS123123SAD11222\",\n \"referenceId\": \"BRICK1234\",\n\t\t\t\t\"bankShortCode\": \"MANDIRI\",\n \"accountNo\": \"130432138889902\",\n \"displayName\": \"BRICK\"\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": { "message": { "type": "string", "example": "We have successfully generated the open VA" }, "id": { "type": "string", "example": "OP_SA123212SDS123123SAD11222" }, "referenceId": { "type": "string", "example": "BRICK1234" }, "bankShortCode": { "type": "string", "example": "MANDIRI" }, "accountNo": { "type": "string", "example": "130432138889902" }, "displayName": { "type": "string", "example": "BRICK" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "bankShortCode not supported": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"Incorrect_format_of_parameters_in_request\",\n \"message\": \"Please use Bank Code that we support in the request query\",\n \"action\": \"Please revisit our API doc to see our supported Bank Code\",\n \"reason\": \"Bank Code is not supported\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "referenceId used": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please make sure your External key (reference id) has never been used before\",\n \"action\": \"Please make sure to always use unique reference ID in the parameter\",\n \"reason\": \"Your external id (referenceId) has already been taken\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "bankShortCode do not use suffixNo": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please do not customize the suffix number for this Bank Code\",\n \"action\": \"Please use the suffix number given without customization\",\n \"reason\": \"Suffix number customization is not supported for this Bank Code\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "bankShortCode tidak didukung", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "Incorrect_format_of_parameters_in_request" }, "message": { "type": "string", "example": "Please use Bank Code that we support in the request query" }, "action": { "type": "string", "example": "Please revisit our API doc to see our supported Bank Code" }, "reason": { "type": "string", "example": "Bank Code is not supported" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "referenceId digunakan", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please make sure your External key (reference id) has never been used before" }, "action": { "type": "string", "example": "Please make sure to always use unique reference ID in the parameter" }, "reason": { "type": "string", "example": "Your external id (referenceId) has already been taken" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "bankShortCode jangan gunakan suffixNo", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please do not customize the suffix number for this Bank Code" }, "action": { "type": "string", "example": "Please use the suffix number given without customization" }, "reason": { "type": "string", "example": "Suffix number customization is not supported for this Bank Code" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } }, "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, "tags": [ "Virtual Account Open VA" ], "x-docs-page": "/brickcollect-acceptance/virtual-account/generate-open-va", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/va/open" }, "get": { "summary": "Status Open VA", "description": "Periksa status pembayaran terbaru untuk Open Virtual Account. Gunakan endpoint ini ketika callbacks tertunda, ketika tim dukungan perlu memverifikasi pembayaran, atau ketika tugas rekonsiliasi Anda perlu mengonfirmasi status VA saat ini. Berikan pengidentifikasi VA yang diperlukan dan gunakan respons untuk memperbarui catatan pembayaran internal.", "operationId": "status-of-open-va", "parameters": [ { "name": "vaId", "in": "query", "description": "Id unik akun virtual misal: OP_xxxx", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have successfully retrieved the open VA\",\n \"id\": \"OP_123451123123\",\n \"referenceId\": \"brick12345\",\n \"bankShortCode\": \"BCA\",\n \"accountNo\": \"1304321312312310\",\n \"displayName\": \"BRICK\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"error\": null\n}\n" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "We have successfully retrieved the open VA" }, "id": { "type": "string", "example": "OP_123451123123" }, "referenceId": { "type": "string", "example": "brick12345" }, "bankShortCode": { "type": "string", "example": "BCA" }, "accountNo": { "type": "string", "example": "1304321312312310" }, "displayName": { "type": "string", "example": "BRICK" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Invalid id": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Transaction ID not found\",\n \"action\": \"Please ensure that the transaction ID is correct\",\n \"reason\": \"We did not find any transaction with such ID\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "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": { "oneOf": [ { "title": "Identitas tidak valid", "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": "Transaction ID not found" }, "action": { "type": "string", "example": "Please ensure that the transaction ID is correct" }, "reason": { "type": "string", "example": "We did not find any transaction with such ID" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "token tidak valid", "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, "tags": [ "Virtual Account Open VA" ], "x-docs-page": "/brickcollect-acceptance/virtual-account/status-open-va", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/va/open" } }, "/v2/payments/gs/va/close": { "post": { "summary": "Generate Close VA", "description": "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.", "operationId": "generate-closed-va", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "referenceId", "bankShortCode", "amount", "expiredAt", "displayName" ], "properties": { "referenceId": { "type": "string", "description": "ID unik yang dihasilkan oleh klien untuk melacak setiap generasi VA", "default": "test-closeVA-1" }, "bankShortCode": { "type": "string", "default": "MANDIRI" }, "amount": { "type": "integer", "description": "Jumlah yang akan dicantumkan di virtual account", "default": 10000, "format": "int32" }, "expiredAt": { "type": "string", "description": "Waktu kedaluwarsa penutupan VA dalam Menit", "default": "60" }, "displayName": { "type": "string", "description": "Nama VA yang ditampilkan", "default": "Close VA test" }, "description": { "type": "string", "description": "Deskripsi yang akan dicantumkan di virtual account (maksimal 255 karakter)", "default": "test-closeVA-1" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n\t\t\t\t\"message\": \"We have successfully generated the close VA\",\n \"id\": \"CL_asd31231SAD123123asasd122\",\n\t\t\t\t\"referenceId\": \"brick12345\",\n \"description\": \"Test Initial VA Close\",\n \"amount\": \"15000.0\",\n \"status\": \"pending\",\n \"createdAt\": \"2021-12-13T14:26:43.000+07:00\",\n \"expiredAt\": \"2021-12-31T15:27:43.000+07:00\",\n \"bankShortCode\": \"MANDIRI\",\n \"accountNo\": \"1304421991909265\",\n \"displayName\": \"IKN-BRICK\"\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": { "message": { "type": "string", "example": "We have successfully generated the close VA" }, "id": { "type": "string", "example": "CL_asd31231SAD123123asasd122" }, "referenceId": { "type": "string", "example": "brick12345" }, "description": { "type": "string", "example": "Test Initial VA Close" }, "amount": { "type": "string", "example": "15000.0" }, "status": { "type": "string", "example": "pending" }, "createdAt": { "type": "string", "example": "2021-12-13T14:26:43.000+07:00" }, "expiredAt": { "type": "string", "example": "2021-12-31T15:27:43.000+07:00" }, "bankShortCode": { "type": "string", "example": "MANDIRI" }, "accountNo": { "type": "string", "example": "1304421991909265" }, "displayName": { "type": "string", "example": "IKN-BRICK" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "bankShortCode not supported": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"Incorrect_format_of_parameters_in_request\",\n \"message\": \"Please use Bank Code that we support in the request query\",\n \"action\": \"Please revisit our API doc to see our supported Bank Code\",\n \"reason\": \"Bank Code is not supported\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "referenceId used": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please make sure your External key (reference id) has never been used before\",\n \"action\": \"Please make sure to always use unique reference ID in the parameter\",\n \"reason\": \"Your external id (referenceId) has already been taken\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "bankShortCode do not use suffixNo": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please do not customize the suffix number for this Bank Code\",\n \"action\": \"Please use the suffix number given without customization\",\n \"reason\": \"Suffix number customization is not supported for this Bank Code\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "bankShortCode tidak didukung", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "Incorrect_format_of_parameters_in_request" }, "message": { "type": "string", "example": "Please use Bank Code that we support in the request query" }, "action": { "type": "string", "example": "Please revisit our API doc to see our supported Bank Code" }, "reason": { "type": "string", "example": "Bank Code is not supported" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "referenceId digunakan", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please make sure your External key (reference id) has never been used before" }, "action": { "type": "string", "example": "Please make sure to always use unique reference ID in the parameter" }, "reason": { "type": "string", "example": "Your external id (referenceId) has already been taken" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "bankShortCode jangan gunakan suffixNo", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please do not customize the suffix number for this Bank Code" }, "action": { "type": "string", "example": "Please use the suffix number given without customization" }, "reason": { "type": "string", "example": "Suffix number customization is not supported for this Bank Code" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } }, "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, "tags": [ "Virtual Account Close VA" ], "x-docs-page": "/brickcollect-acceptance/virtual-account/generate-close-va", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/va/close" }, "get": { "summary": "Status Close VA", "description": "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.", "operationId": "status-of-close-va", "parameters": [ { "name": "vaId", "in": "query", "description": "Id unik akun virtual misal: CL_xxxx", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have successfully retrieved the close VA\",\n\t \"id\": \"BR_1238512012301923\",\n \"referenceId\": \"BRICK-12345\",\n \"description\": \"Test Initial VA Close\",\n \"amount\": \"15000.0\",\n \"status\": \"pending\",\n \"createdAt\": \"2023-03-28T17:12:55.638+07:00\",\n \"expiredAt\": \"2023-03-29T12:07:04.000+07:00\",\n\t\t\t\t\"bankShortCode\": \"MANDIRI\",\n \"accountNo\": \"7001202303299393369\",\n \"displayName\": \"BRICK\"\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": { "message": { "type": "string", "example": "We have successfully retrieved the close VA" }, "id": { "type": "string", "example": "BR_1238512012301923" }, "referenceId": { "type": "string", "example": "BRICK-12345" }, "description": { "type": "string", "example": "Test Initial VA Close" }, "amount": { "type": "string", "example": "15000.0" }, "status": { "type": "string", "example": "pending" }, "createdAt": { "type": "string", "example": "2023-03-28T17:12:55.638+07:00" }, "expiredAt": { "type": "string", "example": "2023-03-29T12:07:04.000+07:00" }, "bankShortCode": { "type": "string", "example": "MANDIRI" }, "accountNo": { "type": "string", "example": "7001202303299393369" }, "displayName": { "type": "string", "example": "BRICK" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "invalid id": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Transaction ID not found\",\n \"action\": \"Please ensure that the transaction ID is correct\",\n \"reason\": \"We did not find any transaction with such ID\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "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": { "oneOf": [ { "title": "identitas tidak valid", "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": "Transaction ID not found" }, "action": { "type": "string", "example": "Please ensure that the transaction ID is correct" }, "reason": { "type": "string", "example": "We did not find any transaction with such ID" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "token tidak valid", "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, "tags": [ "Virtual Account Close VA" ], "x-docs-page": "/brickcollect-acceptance/virtual-account/status-close-va", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/va/close" } }, "/v2/payments/gs/va/close/status/{vaIdCL}": { "post": { "summary": "Simulasi Pembayaran Close VA [PAID/COMPLETED]", "description": "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.", "operationId": "simulate-payment-of-close-va-paid", "parameters": [ { "name": "vaIdCL", "in": "path", "description": "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", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "action" ], "properties": { "action": { "type": "string", "description": "Status yang ingin dicapai (PAID / COMPLETED)", "default": "PAID/COMPLETED" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Virtual Account Close VA" ], "x-docs-page": "/brickcollect-acceptance/virtual-account/simulate-close-va-payment", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/va/close/status/{vaIdCL}" } }, "/v2/payments/gs/qris/dynamic": { "post": { "summary": "Generate Dynamic QR Code", "description": "Buat QRIS QR Code dinamis untuk jumlah pembayaran tertentu dan reference ID. Gunakan endpoint ini ketika setiap transaksi pelanggan memerlukan QR payload unik untuk pengumpulan pembayaran. Responsnya mencakup data QR yang dapat dirender dalam alur checkout Anda, sedangkan status pembayaran akhir harus dikonfirmasi melalui callbacks atau status dinamis QR endpoint.", "operationId": "generate-dynamic-qris", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "referenceId", "amount" ], "properties": { "referenceId": { "type": "string", "description": "Referensi unik Transaksi dari sisi klien (Panjang maksimum 25 karakter)" }, "amount": { "type": "integer", "description": "Jumlah yang ingin ditransfer klien", "format": "int32" }, "validityPeriod": { "type": "string", "description": "Minimum 600 detik (10 menit), maksimum 86.400 detik (24 jam) dari waktu pembuatan. Jika tidak disetel, nilai defaultnya adalah 86.400 detik (24 jam)" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have successfully generated the dynamic qris\",\n \"id\":\"QR_7d13c668fea84081832d02368c61af69\",\n \"referenceId\": \"test-qris-sandbox\",\n \"amount\": 10000,\n \"createdAt\": \"2024-01-16T17:00:00.000+07:00\",\n \"expiredAt\": \"2024-01-17T17:00:00.000+07:00\",\n \"qrData\": \"00020101021226670016COM.NOBUBANK.WWW01189360050300000491530214082500000318170303UKE51440014ID.CO.QR Code.WWW0215ID20200814004210303UKE5204549953033605405100005802ID5914BRICK PAYMENT 6015Banten - Kota T61051581162570114011200010968090620202401121013231606140703A010804POSP630443C4\"\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": { "message": { "type": "string", "example": "We have successfully generated the dynamic qris" }, "id": { "type": "string", "example": "QR_7d13c668fea84081832d02368c61af69" }, "referenceId": { "type": "string", "example": "test-qris-sandbox" }, "amount": { "type": "integer", "example": 10000, "default": 0 }, "createdAt": { "type": "string", "example": "2024-01-16T17:00:00.000+07:00" }, "expiredAt": { "type": "string", "example": "2024-01-17T17:00:00.000+07:00" }, "qrData": { "type": "string", "example": "00020101021226670016COM.NOBUBANK.WWW01189360050300000491530214082500000318170303UKE51440014ID.CO.QR Code.WWW0215ID20200814004210303UKE5204549953033605405100005802ID5914BRICK PAYMENT 6015Banten - Kota T61051581162570114011200010968090620202401121013231606140703A010804POSP630443C4" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Public token in invalid ": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"missing_parameters_in_headers\",\n \"message\": \"Please use API with publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/payments/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"publicAccessToken is missing from headers\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "Public token expired": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"expired_parameters_in_headers\",\n \"message\": \"Please use live publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/payments/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"publicAccessToken is expired\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "Token publik tidak valid ", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "missing_parameters_in_headers" }, "message": { "type": "string", "example": "Please use API with publicAccessToken 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": "publicAccessToken is missing from headers" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "Token publik sudah habis masa berlakunya", "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "expired_parameters_in_headers" }, "message": { "type": "string", "example": "Please use live publicAccessToken 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": "publicAccessToken is expired" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } } }, "deprecated": false, "tags": [ "QR Code Dinamis" ], "x-docs-page": "/brickcollect-acceptance/qris/dynamic/generate-dynamic-qris", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/qris/dynamic" } }, "/v2/payments/gs/qris/dynamic/{referenceId}": { "get": { "summary": "Status Dynamic QR Code", "description": "Periksa status terbaru transaksi QRIS dinamis dengan reference ID. Gunakan endpoint ini ketika sistem Anda perlu mengonfirmasi apakah pembayaran QR masih diproses, sudah dibayar, kedaluwarsa, atau belum terselesaikan. Ini melengkapi callbacks dan berguna untuk pekerjaan rekonsiliasi, pemeriksaan dukungan pelanggan, dan layar konfirmasi pembayaran.", "operationId": "status-dynamic-qris", "parameters": [ { "name": "referenceId", "in": "path", "description": "referenceId Transaksi yang unik", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"status\": 200,\n \"data\": {\n \"id\": \"QR_7d13c668fea84081832d02368c61af69\",\n \"referenceId\": \"test-qris-sandbox\",\n \"amount\": 10000,\n \"status\": \"processing\",\n \"qrData\": \"00020101021226670016COM.NOBUBANK.WWW01189360050300000491530214082500000318170303UKE51440014ID.CO.QR Code.WWW0215ID20200814004210303UKE5204549953033605405100005802ID5914BRICK PAYMENT 6015Banten - Kota T61051581162570114011200010968090620202401121013231606140703A010804POSP630443C4\",\n \"paidAt\": null\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": { "id": { "type": "string", "example": "QR_7d13c668fea84081832d02368c61af69" }, "referenceId": { "type": "string", "example": "test-qris-sandbox" }, "amount": { "type": "integer", "example": 10000, "default": 0 }, "status": { "type": "string", "example": "processing" }, "qrData": { "type": "string", "example": "00020101021226670016COM.NOBUBANK.WWW01189360050300000491530214082500000318170303UKE51440014ID.CO.QR Code.WWW0215ID20200814004210303UKE5204549953033605405100005802ID5914BRICK PAYMENT 6015Banten - Kota T61051581162570114011200010968090620202401121013231606140703A010804POSP630443C4" }, "paidAt": {} } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Public token in invalid ": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Please use valid publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"Invalid publicAccessToken in headers\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } } } } } }, "deprecated": false, "tags": [ "QR Code Dinamis" ], "x-docs-page": "/brickcollect-acceptance/qris/dynamic/dynamic-qris-status", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/qris/dynamic/{referenceId}" } }, "/v2/payments/gs/qris/update-status-sandbox": { "post": { "summary": "Pengujian QR Code di Sandbox", "description": "Simulasikan perubahan status pembayaran QRIS di lingkungan sandbox sehingga tim Anda dapat menguji penanganan dan rekonsiliasi callback sebelum produksi. Gunakan endpoint ini setelah membuat QR Code dinamis sandbox untuk memindahkan transaksi ke status pengujian yang diinginkan. Jangan gunakan untuk pembayaran produksi atau transaksi pelanggan langsung.", "operationId": "qris-testing-in-sandbox", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "referenceId", "status" ], "properties": { "referenceId": { "type": "string", "description": "referenceId Transaksi yang unik" }, "status": { "type": "string", "description": "Status yang ingin dicapai (PAID/COMPLETED)", "default": "PAID/COMPLETED" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"status\": 200,\n \"data\": \"We've successfully updated the qris transaction status.\",\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": "string", "example": "We've successfully updated the qris transaction status." }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Public token in invalid ": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Failed update QR Code status\",\n \"action\": \"Please check the parameter request\",\n \"reason\": \"Cannot change status from COMPLETED / EXPIRED / PAID back to PROCESSING\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Failed update QR Code status" }, "action": { "type": "string", "example": "Please check the parameter request" }, "reason": { "type": "string", "example": "Cannot change status from COMPLETED / EXPIRED / PAID back to PROCESSING" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "QR Code Dinamis" ], "x-docs-page": "/brickcollect-acceptance/qris/dynamic/qris-testing-sandbox", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/qris/update-status-sandbox" } }, "/v2/payments/gs/qris/merchant/bulk": { "get": { "summary": "Lihat Daftar Merchant Static QR Code", "description": "Ambil daftar pedagang QRIS statis yang tersedia untuk akun Brick Anda. Gunakan endpoint ini untuk menyinkronkan pengidentifikasi pedagang ke alat internal Anda sebelum menampilkan atau merekonsiliasi alur pembayaran QR Code statis. Responsnya membantu memetakan data pedagang ke transaksi QR statis dan pelaporan operasional.", "operationId": "static-qris-get-merchant-list", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"status\": 200,\n \"data\": [\n {\n \"id\": 25,\n \"name\": \"Example Merchant\",\n \"email\": \"customer@example.com\",\n \"ownerName\": \"Example Customer\",\n \"address\": \"Example Address\",\n \"nmid\": \"ID2020088800402\",\n \"qrisImageUrl\": \"{{url_qr_code_merchant}}\",\n \"status\": \"VERIFIED\"\n }\n ],\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"error\": null\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Public token in invalid ": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Please use valid publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"Invalid publicAccessToken in headers\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } } } } } }, "deprecated": false, "tags": [ "QR Code Statis" ], "x-docs-page": "/brickcollect-acceptance/qris/static/merchant-list", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/qris/merchant/bulk" } }, "/v2/payments/gs/qris/merchant/{id}": { "get": { "summary": "Lihat Detail Merchant Static QR Code", "description": "Ambil detail untuk pedagang QRIS statis tertentu berdasarkan pedagang ID. Gunakan endpoint ini ketika sistem Anda memerlukan metadata pedagang, detail identitas QR, atau konteks operasional sebelum merekonsiliasi pembayaran QR statis. Responsnya mendukung layar pencarian pedagang, pemeriksaan perutean pembayaran, dan alur kerja dukungan.", "operationId": "static-qris-get-merchant-details", "parameters": [ { "name": "id", "in": "path", "description": "ID unik dari Pedagang QR Code", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"status\": 200,\n \"data\": {\n \"id\": 25,\n \"name\": \"Example Merchant\",\n \"email\": \"customer@example.com\",\n \"ownerName\": \"Example Customer\",\n \"address\": \"Example Address\",\n \"nmid\": \"ID2020088800402\",\n \"qrisImageUrl\": \"{{url_qr_code_merchant}}\",\n \"status\": \"VERIFIED\"\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": { "id": { "type": "integer", "example": 25, "default": 0 }, "name": { "type": "string", "example": "Example Merchant" }, "email": { "type": "string", "example": "customer@example.com" }, "ownerName": { "type": "string", "example": "Example Customer" }, "address": { "type": "string", "example": "Example Address" }, "nmid": { "type": "string", "example": "ID2020088800402" }, "qrisImageUrl": { "type": "string", "example": "{{url_qr_code_merchant}}" }, "status": { "type": "string", "example": "VERIFIED" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Public token in invalid ": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Please use valid publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"Invalid publicAccessToken in headers\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } } } } } }, "deprecated": false, "tags": [ "QR Code Statis" ], "x-docs-page": "/brickcollect-acceptance/qris/static/merchant-details", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/qris/merchant/{id}" } }, "/v2/payments/gs/qris/static/{referenceId}": { "get": { "summary": "Status Static QR Code", "description": "Periksa status terbaru transaksi QRIS statis dengan reference ID. Gunakan endpoint ini ketika Anda perlu mengonfirmasi status pembayaran untuk aliran QR Code statis yang disajikan pedagang. Ini melengkapi callbacks dan membantu tim operasi menyelesaikan pertanyaan konfirmasi pembayaran, rekonsiliasi, atau dukungan pelanggan.", "operationId": "status-for-static-qris", "parameters": [ { "name": "referenceId", "in": "path", "description": "referenceId Transaksi yang unik", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"status\": 200,\n \"data\": {\n \"referenceId\": \"XXXX\",\n \"id\": \"QR_XXXX\",\n \"amount\": 32000,\n \"status\": \"completed\",\n \"qrData\": \"\",\n \"paidAt\": \"2024-03-05T01:51:01.000+07:00\",\n \"type\": \"STATIC\",\n \"merchant\": \"merchant_name\",\n \"merchantNmid\": \"merchat_Nmid\"\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": { "referenceId": { "type": "string", "example": "XXXX" }, "id": { "type": "string", "example": "QR_XXXX" }, "amount": { "type": "integer", "example": 32000, "default": 0 }, "status": { "type": "string", "example": "completed" }, "qrData": { "type": "string", "example": "" }, "paidAt": { "type": "string", "example": "2024-03-05T01:51:01.000+07:00" }, "type": { "type": "string", "example": "STATIC" }, "merchant": { "type": "string", "example": "merchant_name" }, "merchantNmid": { "type": "string", "example": "merchat_Nmid" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Public token in invalid ": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Please use valid publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"Invalid publicAccessToken in headers\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } } } } } }, "deprecated": false, "tags": [ "QR Code Statis" ], "x-docs-page": "/brickcollect-acceptance/qris/static/static-qris-status", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/qris/static/{referenceId}" } }, "/v2/payments/acceptance/1.0/access-token/b2b": { "post": { "summary": "Dapatkan Access Token (SNAP)", "description": "Hasilkan token akses SNAP B2B yang diperlukan untuk titik akhir QR Code SNAP. Kirim header SNAP, tanda tangan, stempel waktu, dan kunci klien yang diperlukan sesuai dengan pengaturan kredensial Brick SNAP Anda. Gunakan token yang dikembalikan saat membuat pembayaran QR MPM atau menanyakan status pembayaran QR melalui alur yang kompatibel dengan SNAP.", "operationId": "get-access-token-snap", "parameters": [ { "name": "Content-Type", "in": "header", "description": "String mewakili menunjukkan jenis media sumber daya", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "X-CLIENT-KEY", "in": "header", "description": "Client_id klien", "required": true, "schema": { "type": "string", "default": "YOUR_CLIENT_ID" } }, { "name": "X-TIMESTAMP", "in": "header", "description": "Waktu lokal klien saat ini dalam format yyyy-MM- ddTHH:mm:ss.SSSTZD", "required": true, "schema": { "type": "string", "format": "date", "default": "2024-11-11T18:44:33+07:00" } }, { "name": "X-SIGNATURE", "in": "header", "description": "Tanda tangan pemeriksaan Non-Penyangkalan & Integritas untuk permintaan", "required": true, "schema": { "type": "string", "default": "YOUR_SIGNATURE" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "grant_type" ], "properties": { "grant_type": { "type": "string", "description": "Harus berupa \"kredensial_klien\"", "default": "client_credentials" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"responseCode\": \"2007300\",\n \"responseMessage\": \"Successful\",\n \"accessToken\": \"YOUR_ACCESS_TOKEN\",\n \"tokenType\": \"Bearer\",\n \"expiresIn\": \"900\"\n}" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "2007300" }, "responseMessage": { "type": "string", "example": "Successful" }, "accessToken": { "type": "string", "example": "YOUR_ACCESS_TOKEN" }, "tokenType": { "type": "string", "example": "Bearer" }, "expiresIn": { "type": "string", "example": "900" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid Payload": { "value": "{\n \"responseCode\": \"4007302\",\n \"responseMessage\": \"Invalid Mandatory Field\"\n}" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "4007302" }, "responseMessage": { "type": "string", "example": "Invalid Mandatory Field" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized": { "value": "{\n \"responseCode\": \"4017300\",\n \"responseMessage\": \"Unauthorized X-SIGNATURE\"\n}" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "4017300" }, "responseMessage": { "type": "string", "example": "Unauthorized X-SIGNATURE" } } } } } } }, "deprecated": false, "tags": [ "QR Code SNAP" ], "x-docs-page": "/brickcollect-acceptance/qris/snap/get-access-token", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [], "x-brick-endpoint-base-path": "/v2/payments", "x-brick-original-path": "/acceptance/1.0/access-token/b2b" } }, "/v2/payments/acceptance/1.0/qr/qr-mpm-generate": { "post": { "summary": "Generate Dynamic QR Code (SNAP)", "description": "Buat pembayaran QRIS MPM dinamis menggunakan header permintaan yang kompatibel dengan SNAP dan struktur payload. Gunakan endpoint ini ketika integrasi Anda mengikuti standar SNAP Indonesia untuk pembuatan pembayaran QR, termasuk tanda tangan, stempel waktu, referensi mitra, dan informasi pedagang. Responsnya mengembalikan konten dan pengidentifikasi QR yang harus direkonsiliasi melalui penyelidikan status SNAP atau callbacks.", "operationId": "generate-dynamic-qris-snap", "parameters": [ { "name": "Content-Type", "in": "header", "description": "String mewakili menunjukkan jenis media sumber daya", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "X-CLIENT-KEY", "in": "header", "description": "Client_id klien", "required": true, "schema": { "type": "string", "default": "YOUR_CLIENT_ID" } }, { "name": "X-TIMESTAMP", "in": "header", "description": "Waktu lokal klien saat ini dalam format yyyy-MM- ddTHH:mm:ss.SSSTZD", "required": true, "schema": { "type": "string", "format": "date", "default": "2024-11-15T18:44:33+07:00" } }, { "name": "Authorization", "in": "header", "description": "Token akses satu kali dibuat menggunakan token autentikasi API", "required": true, "schema": { "type": "string", "default": "Bearer YOUR_ACCESS_TOKEN" } }, { "name": "X-SIGNATURE", "in": "header", "description": "Tanda tangan pemeriksaan Non-Penyangkalan & Integritas untuk permintaan", "required": true, "schema": { "type": "string", "default": "YOUR_SIGNATURE" } }, { "name": "X-PARTNER-ID", "in": "header", "description": "klien Brick ID", "required": true, "schema": { "type": "string", "default": "YOUR_PARTNER_ID" } }, { "name": "X-EXTERNAL-ID", "in": "header", "description": "Pengidentifikasi eksternal unik untuk permintaan API yang dapat ditemukan di Kredensial Dasbor Brick", "required": true, "schema": { "type": "string", "default": "external-id-unique-per-request" } }, { "name": "CHANNEL-ID", "in": "header", "description": "id saluran Brick", "required": true, "schema": { "type": "string", "default": "A0" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "partnerReferenceNo", "validityPeriod" ], "properties": { "partnerReferenceNo": { "type": "string", "description": "Nomor referensi unik yang diberikan oleh mitra untuk mengidentifikasi transaksi. Panjang maksimum 25 karakter)", "default": "2025111500000000000001" }, "amount": { "properties": { "value": { "type": "string", "description": "Jumlah yang akan diproses, direpresentasikan sebagai string dengan dua tempat desimal (misalnya, \"12345678.00\")", "default": "10000.00" }, "currency": { "type": "string", "description": "Mata uang dari jumlah transaksi. Tetapkan sebagai default ke \"IDR\" (Rupiah Indonesia).", "default": "IDR" } }, "required": [ "value", "currency" ], "type": "object" }, "validityPeriod": { "type": "string", "description": "Minimum 600 detik (10 menit), maksimum 86.400 detik (24 jam) dari waktu pembuatan. Jika tidak disetel, nilai defaultnya adalah 86.400 detik (24 jam)", "default": "600" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"responseCode\": \"2004700\",\n \"responseMessage\": \"Successful\",\n \"referenceNo\": \"QR_429529d44e1f4e22a167a8b0597f1226\",\n \"partnerReferenceNo\": \"87457990831641724058\",\n \"qrContent\": \"00020101021226640015ID.OTTOCASH.WWW01189360081110020080020212OP1D012981900303UME51440014ID.CO.QR Code.WWW0215ID10243527937710303UME520499995303360540410005802ID5910TULOBRICK16015JL KARYA BHAKTI61057812162720120BILL14155627188675030521SP17395233874158600180703A019612OP1D012981906304A393\"\n}" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "2004700" }, "responseMessage": { "type": "string", "example": "Successful" }, "referenceNo": { "type": "string", "example": "QR_429529d44e1f4e22a167a8b0597f1226" }, "partnerReferenceNo": { "type": "string", "example": "87457990831641724058" }, "qrContent": { "type": "string", "example": "00020101021226640015ID.OTTOCASH.WWW01189360081110020080020212OP1D012981900303UME51440014ID.CO.QR Code.WWW0215ID10243527937710303UME520499995303360540410005802ID5910TULOBRICK16015JL KARYA BHAKTI61057812162720120BILL14155627188675030521SP17395233874158600180703A019612OP1D012981906304A393" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid Payload": { "value": "{\n \"responseCode\": \"4004702\",\n \"responseMessage\": \"Invalid Mandatory Field\"\n}" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "4004702" }, "responseMessage": { "type": "string", "example": "Invalid Mandatory Field" } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Unauthorized Authorization": { "value": "{\n \"responseCode\": \"4014700\",\n \"responseMessage\": \"Unauthorized Authorization\"\n}" }, "Unauthorized Signature": { "value": "{\n \"responseCode\": \"4014700\",\n \"responseMessage\": \"Unauthorized X-SIGNATURE\"\n}" } }, "schema": { "oneOf": [ { "title": "Otorisasi Tidak Sah", "type": "object", "properties": { "responseCode": { "type": "string", "example": "4014700" }, "responseMessage": { "type": "string", "example": "Unauthorized Authorization" } } }, { "title": "Tanda Tangan Tidak Sah", "type": "object", "properties": { "responseCode": { "type": "string", "example": "4014700" }, "responseMessage": { "type": "string", "example": "Unauthorized X-SIGNATURE" } } } ] } } } }, "409": { "description": "409", "content": { "application/json": { "examples": { "Same x-external-id on the Same Day": { "value": "{\n \"responseCode\": \"4094700\",\n \"responseMessage\": \"Conflict\"\n}" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "4094700" }, "responseMessage": { "type": "string", "example": "Conflict" } } } } } } }, "deprecated": false, "tags": [ "QR Code SNAP" ], "x-docs-page": "/brickcollect-acceptance/qris/snap/generate-dynamic-qris-snap", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [], "x-brick-endpoint-base-path": "/v2/payments", "x-brick-original-path": "/acceptance/1.0/qr/qr-mpm-generate" } }, "/v2/payments/acceptance/1.0/qr/qr-mpm-query": { "post": { "summary": "Status Dynamic QR Code", "description": "Kueri status pembayaran terbaru untuk transaksi QRIS SNAP dinamis. Gunakan endpoint ini ketika sistem Anda perlu mengonfirmasi status pembayaran QR MPM menggunakan header SNAP, stempel waktu, tanda tangan, dan data referensi mitra asli. Responsnya membantu merekonsiliasi transaksi QR yang tertunda, berhasil, gagal, atau kedaluwarsa dalam integrasi berbasis SNAP.", "operationId": "status-for-dynamic-qris-snap", "parameters": [ { "name": "Content-Type", "in": "header", "description": "String mewakili menunjukkan jenis media sumber daya", "required": true, "schema": { "type": "string", "default": "application/json" } }, { "name": "X-CLIENT-KEY", "in": "header", "description": "Client_id klien", "required": true, "schema": { "type": "string", "default": "YOUR_CLIENT_ID" } }, { "name": "X-TIMESTAMP", "in": "header", "description": "Waktu lokal klien saat ini dalam format yyyy-MM- ddTHH:mm:ss.SSSTZD", "required": true, "schema": { "type": "string", "format": "date", "default": "2024-11-15T18:44:33+07:00" } }, { "name": "Authorization", "in": "header", "description": "Token akses satu kali dibuat menggunakan token autentikasi API", "required": true, "schema": { "type": "string", "default": "Bearer YOUR_ACCESS_TOKEN" } }, { "name": "X-SIGNATURE", "in": "header", "description": "Tanda tangan pemeriksaan Non-Penyangkalan & Integritas untuk permintaan", "required": true, "schema": { "type": "string", "default": "YOUR_SIGNATURE" } }, { "name": "X-PARTNER-ID", "in": "header", "description": "klien Brick ID", "required": true, "schema": { "type": "string", "default": "YOUR_PARTNER_ID" } }, { "name": "X-EXTERNAL-ID", "in": "header", "description": "Pengidentifikasi eksternal unik untuk permintaan API yang dapat ditemukan di Kredensial Dasbor Brick", "required": true, "schema": { "type": "string", "default": "external-id-unique-per-request" } }, { "name": "CHANNEL-ID", "in": "header", "description": "id saluran Brick", "required": true, "schema": { "type": "string", "default": "A0" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "originalReferenceNo": { "type": "string", "description": "Pengidentifikasi unik untuk transaksi asli. misalnya QR_75ae1b56c40449ecbc42010e3d2589cc", "default": "QR_75ae1b56c40449ecbc42010e3d2589cc" }, "originalPartnerReferenceNo": { "type": "string", "description": "Pengidentifikasi unik untuk transaksi asli yang diberikan oleh mitra. misalnya 20241115000000189723", "default": "20241115000000189723" }, "serviceCode": { "type": "string", "description": "Harus disetel ke '51'", "default": "51" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"responseCode\": \"2005100\",\n \"responseMessage\": \"Successful\",\n \"originalReferenceNo\": \"QR_75ae1b56c40449ecbc42010e3d2589cc\",\n \"originalPartnerReferenceNo\": \"20241115000000189723\",\n \"serviceCode\": \"51\",\n \"latestTransactionStatus\": \"06\",\n \"transactionStatusDesc\": \"EXPIRED\",\n \"amount\": {\n \"value\": \"10000.00\",\n \"currency\": \"IDR\"\n }\n}" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "2005100" }, "responseMessage": { "type": "string", "example": "Successful" }, "originalReferenceNo": { "type": "string", "example": "QR_75ae1b56c40449ecbc42010e3d2589cc" }, "originalPartnerReferenceNo": { "type": "string", "example": "20241115000000189723" }, "serviceCode": { "type": "string", "example": "51" }, "latestTransactionStatus": { "type": "string", "example": "06" }, "transactionStatusDesc": { "type": "string", "example": "EXPIRED" }, "amount": { "type": "object", "properties": { "value": { "type": "string", "example": "10000.00" }, "currency": { "type": "string", "example": "IDR" } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Invalid Mandatory Field": { "value": "{\n \"responseCode\": \"4005102\",\n \"responseMessage\": \"Invalid Mandatory Field\"\n}" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "4005102" }, "responseMessage": { "type": "string", "example": "Invalid Mandatory Field" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Transaction Not Found": { "value": "{\n \"responseCode\": \"4045101\",\n \"responseMessage\": \"Transaction Not Found\",\n \"originalReferenceNo\": \"QR_75ae1b56c40449ecbc42010e3d2589ccx\",\n \"originalPartnerReferenceNo\": \"20241115000000189723\",\n \"serviceCode\": \"51\",\n \"latestTransactionStatus\": \"07\",\n \"transactionStatusDesc\": \"NOT_FOUND\"\n}\n" } }, "schema": { "type": "object", "properties": { "responseCode": { "type": "string", "example": "4045101" }, "responseMessage": { "type": "string", "example": "Transaction Not Found" }, "originalReferenceNo": { "type": "string", "example": "QR_75ae1b56c40449ecbc42010e3d2589ccx" }, "originalPartnerReferenceNo": { "type": "string", "example": "20241115000000189723" }, "serviceCode": { "type": "string", "example": "51" }, "latestTransactionStatus": { "type": "string", "example": "07" }, "transactionStatusDesc": { "type": "string", "example": "NOT_FOUND" } } } } } } }, "deprecated": false, "tags": [ "QR Code SNAP" ], "x-docs-page": "/brickcollect-acceptance/qris/snap/dynamic-qris-status-snap", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [], "x-brick-endpoint-base-path": "/v2/payments", "x-brick-original-path": "/acceptance/1.0/qr/qr-mpm-query" } }, "/v2/payments/gs/acceptance/ewallet": { "post": { "summary": "API Buat Link Pembayaran Ewallet", "description": "Buat tautan pembayaran Ewallet atau alihkan URL untuk pembayaran pelanggan. Gunakan endpoint ini ketika pembayar harus menyelesaikan pembayaran dalam aplikasi Ewallet yang didukung atau pengalaman checkout yang dialihkan. Simpan pengidentifikasi pembayaran yang dikembalikan dan alihkan URL, lalu konfirmasi status transaksi akhir melalui callback atau status Ewallet endpoint.", "operationId": "create-payment-ewallet", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "amount", "referenceId", "ewalletCode", "returnUrl" ], "properties": { "amount": { "type": "integer", "description": "Jumlah yang ingin ditransfer klien", "default": 10000, "format": "int32" }, "referenceId": { "type": "string", "description": "Pengidentifikasi unik untuk transaksi pembayaran, yang dihasilkan oleh sisi klien. (Panjang maksimum 25 karakter)", "default": "Test-Sandbox-01" }, "ewalletCode": { "type": "string", "description": "Kode yang mewakili penyedia Ewallet (misalnya, \"DANA\" untuk DANA Ewallet).", "default": "DANA" }, "returnUrl": { "type": "string", "description": "URL ke mana pengguna akhir akan diarahkan setelah menyelesaikan transaksi.", "default": "https://staging-app.onebrick.io" } } }, "examples": { "Request Example": { "value": { "amount": 10000, "referenceId": "Test-Sandbox-01", "ewalletCode": "DANA", "returnUrl": "https://staging-app.onebrick.io" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have successfully created Ewallet payment\",\n \"id\": \"WA_6149a003a0cb4efcab067c342f499f8e\",\n \"referenceId\": \"Test-Sandbox-01\",\n \"amount\": \"10000\",\n \"status\": \"pending\",\n \"ewalletCode\": \"DANA\",\n \"redirectUrl\": \"https://m.sandbox.dana.id/m/portal/cashier/checkout?bizNo=20240912111212800110166401001777756×tamp=1726139689936&originSourcePlatform=IPG&mid=216620040016026395535&sign=IheVHgdUym9p11XLDZ0KqT1%2F5uKqqNjG%2B85CpmVL6LFaJwKPKoEzjTxm8bqg0Vl9CF8G1blf2YUxmNlqeNKvMUoaDh5K%2F50sEscp2fjjY3VnJU4rqiug57Lu1JLGVQ9H%2BL9ff3Kohfz4YEJ3v4kT0mJQZke%2F5Io0PytviPmaMUuOCA%2F9AmeSKg2UVEWbsZdYNbRioLChfAFivnY2Zbv70XQ8wBkOgF1KBnRqh6ONmzCcrSu9EmgoCldPEegZnpGsa0%2BR28W%2FwZ7ZKpi76bLV62Soeg4uQtRoKOcAA6iVhHZ8rmGSFjHGgnpr6C6fgberCfy3cBRlOoLhCE67e1L2tg%3D%3D&forceToH5=false\",\n \"createdAt\": \"2024-09-12T18:14:49.000+07:00\",\n \"expiredAt\": \"2024-09-12T19:15:49.817+07:00\"\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": { "message": { "type": "string", "example": "We have successfully created Ewallet payment" }, "id": { "type": "string", "example": "WA_6149a003a0cb4efcab067c342f499f8e" }, "referenceId": { "type": "string", "example": "Test-Sandbox-01" }, "amount": { "type": "string", "example": "10000" }, "status": { "type": "string", "example": "pending" }, "ewalletCode": { "type": "string", "example": "DANA" }, "redirectUrl": { "type": "string", "example": "https://m.sandbox.dana.id/m/portal/cashier/checkout?bizNo=20240912111212800110166401001777756×tamp=1726139689936&originSourcePlatform=IPG&mid=216620040016026395535&sign=IheVHgdUym9p11XLDZ0KqT1%2F5uKqqNjG%2B85CpmVL6LFaJwKPKoEzjTxm8bqg0Vl9CF8G1blf2YUxmNlqeNKvMUoaDh5K%2F50sEscp2fjjY3VnJU4rqiug57Lu1JLGVQ9H%2BL9ff3Kohfz4YEJ3v4kT0mJQZke%2F5Io0PytviPmaMUuOCA%2F9AmeSKg2UVEWbsZdYNbRioLChfAFivnY2Zbv70XQ8wBkOgF1KBnRqh6ONmzCcrSu9EmgoCldPEegZnpGsa0%2BR28W%2FwZ7ZKpi76bLV62Soeg4uQtRoKOcAA6iVhHZ8rmGSFjHGgnpr6C6fgberCfy3cBRlOoLhCE67e1L2tg%3D%3D&forceToH5=false" }, "createdAt": { "type": "string", "example": "2024-09-12T18:14:49.000+07:00" }, "expiredAt": { "type": "string", "example": "2024-09-12T19:15:49.817+07:00" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Amount Exceed Limit": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please use amount less than maximum transfer limit, ie:10.000.000\",\n \"action\": \"Please make sure the amount you requested is in the range of Rp 10.000 to Rp 10.000.000\",\n \"reason\": \"Your amount of transfer is above our maximum transfer amount\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" }, "Duplicated Reference ID": { "value": "{\n \"status\": 400,\n \"error\": {\n \"code\": \"invalid_parameters_in_request\",\n \"message\": \"Please make sure your External key (reference id) has never been used before\",\n \"action\": \"Please make sure to always use unique reference ID in the parameter\",\n \"reason\": \"Your external id (referenceId) has already been taken\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"data\": null\n}" } }, "schema": { "oneOf": [ { "title": "Jumlah Melebihi Batas", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please use amount less than maximum transfer limit, ie:10.000.000" }, "action": { "type": "string", "example": "Please make sure the amount you requested is in the range of Rp 10.000 to Rp 10.000.000" }, "reason": { "type": "string", "example": "Your amount of transfer is above our maximum transfer amount" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } }, { "title": "Reference ID digandakan", "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "invalid_parameters_in_request" }, "message": { "type": "string", "example": "Please make sure your External key (reference id) has never been used before" }, "action": { "type": "string", "example": "Please make sure to always use unique reference ID in the parameter" }, "reason": { "type": "string", "example": "Your external id (referenceId) has already been taken" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } ] } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Public Token Invalid ": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"token_used_in_headers\",\n \"message\": \"Please use live publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/payments/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"publicAccessToken is used\"\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": "token_used_in_headers" }, "message": { "type": "string", "example": "Please use live publicAccessToken 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": "publicAccessToken is used" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Ewallet" ], "x-docs-page": "/brickcollect-acceptance/e-wallet/create-ewallet-payment-link", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/acceptance/ewallet" } }, "/v2/payments/gs/acceptance/ewallet/{id}": { "get": { "summary": "API Status Pembayaran Ewallet", "description": "Ambil status terkini transaksi pembayaran Ewallet dengan Brick reference ID. Gunakan endpoint ini ketika callbacks tertunda, dukungan pelanggan memerlukan konfirmasi, atau proses rekonsiliasi Anda perlu menyelesaikan status tautan pembayaran. Responsnya harus digunakan untuk memperbarui catatan pesanan internal, faktur, atau pendanaan dompet.", "operationId": "status-ewallet-payment", "parameters": [ { "name": "id", "in": "path", "description": "Pengidentifikasi unik untuk transaksi pembayaran, dihasilkan oleh Brick. EX: WA_xxx", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Success Response - Pending": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have successfully get status Ewallet\",\n \"id\": \"WA_6149a003a0cb4efcab067c342f499f8e\",\n \"referenceId\": \"Test-Sandbox-01\",\n \"amount\": \"10000\",\n \"status\": \"pending\",\n \"ewalletCode\": \"DANA\",\n \"redirectUrl\": \"https://m.sandbox.dana.id/m/portal/cashier/checkout?bizNo=20240912111212800110166401001777756×tamp=1726139689936&originSourcePlatform=IPG&mid=216620040016026395535&sign=IheVHgdUym9p11XLDZ0KqT1%2F5uKqqNjG%2B85CpmVL6LFaJwKPKoEzjTxm8bqg0Vl9CF8G1blf2YUxmNlqeNKvMUoaDh5K%2F50sEscp2fjjY3VnJU4rqiug57Lu1JLGVQ9H%2BL9ff3Kohfz4YEJ3v4kT0mJQZke%2F5Io0PytviPmaMUuOCA%2F9AmeSKg2UVEWbsZdYNbRioLChfAFivnY2Zbv70XQ8wBkOgF1KBnRqh6ONmzCcrSu9EmgoCldPEegZnpGsa0%2BR28W%2FwZ7ZKpi76bLV62Soeg4uQtRoKOcAA6iVhHZ8rmGSFjHGgnpr6C6fgberCfy3cBRlOoLhCE67e1L2tg%3D%3D&forceToH5=false\",\n \"expiredAt\": \"2024-09-12T19:15:49.817+07:00\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"error\": null\n}" }, "Success Response - Completed": { "value": "{\n \"status\": 200,\n \"data\": {\n \"message\": \"We have successfully get status Ewallet\",\n \"id\": \"WA_85a356ed7a4d460c9033905a314f4b9f\",\n \"referenceId\": \"Test-Sandbox-03\",\n \"amount\": \"10000\",\n \"status\": \"completed\",\n \"ewalletCode\": \"DANA\",\n \"redirectUrl\": \"https://m.sandbox.dana.id/m/portal/cashier/checkout?bizNo=20240913111212800110166428801774762×tamp=1726198476396&originSourcePlatform=IPG&mid=216620040016026395535&sign=ae0XxUMldxGjS4oJDf3XuzWhx9fHYCz7Be%2BG8zUAWZAtc1axXlBSB4uzO%2FVX8IqvpIm5mZMCKwBWALPi8F2KHMpO566juhFvVxqpQ0%2B5v8w%2BdJngzMETKgcD6g6sY28V1sOR3BOy32CZQWxzRqVmvNX32Jdh5YHuuLepMnqdAWYPBcnTu6laj%2BcuHIEJoJXRX5n%2Fnp9UDQ6OBcE%2FX9CBKXmzIXGQ%2BDJWyO%2BBRZnoNmbzyUzhRvWOH13h3abmj7kDY33xpmwOiZoBAYNVq6TZnqbEXFQPPnTiV0NV7ry%2BCDOLbTMChcO0erurZZ%2FlJEltqIicp8WCIMcN%2BE5%2ForDKpQ%3D%3D&forceToH5=false\",\n \"expiredAt\": \"2024-09-13T11:35:36.296+07:00\"\n },\n \"metaData\": {\n \"source\": \"API\",\n \"entity\": \"Payment\"\n },\n \"error\": null\n}" } }, "schema": { "oneOf": [ { "title": "Respons Sukses - Menunggu Keputusan", "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "We have successfully get status Ewallet" }, "id": { "type": "string", "example": "WA_6149a003a0cb4efcab067c342f499f8e" }, "referenceId": { "type": "string", "example": "Test-Sandbox-01" }, "amount": { "type": "string", "example": "10000" }, "status": { "type": "string", "example": "pending" }, "ewalletCode": { "type": "string", "example": "DANA" }, "redirectUrl": { "type": "string", "example": "https://m.sandbox.dana.id/m/portal/cashier/checkout?bizNo=20240912111212800110166401001777756×tamp=1726139689936&originSourcePlatform=IPG&mid=216620040016026395535&sign=IheVHgdUym9p11XLDZ0KqT1%2F5uKqqNjG%2B85CpmVL6LFaJwKPKoEzjTxm8bqg0Vl9CF8G1blf2YUxmNlqeNKvMUoaDh5K%2F50sEscp2fjjY3VnJU4rqiug57Lu1JLGVQ9H%2BL9ff3Kohfz4YEJ3v4kT0mJQZke%2F5Io0PytviPmaMUuOCA%2F9AmeSKg2UVEWbsZdYNbRioLChfAFivnY2Zbv70XQ8wBkOgF1KBnRqh6ONmzCcrSu9EmgoCldPEegZnpGsa0%2BR28W%2FwZ7ZKpi76bLV62Soeg4uQtRoKOcAA6iVhHZ8rmGSFjHGgnpr6C6fgberCfy3cBRlOoLhCE67e1L2tg%3D%3D&forceToH5=false" }, "expiredAt": { "type": "string", "example": "2024-09-12T19:15:49.817+07:00" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } }, { "title": "Respons Sukses - Selesai", "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "message": { "type": "string", "example": "We have successfully get status Ewallet" }, "id": { "type": "string", "example": "WA_85a356ed7a4d460c9033905a314f4b9f" }, "referenceId": { "type": "string", "example": "Test-Sandbox-03" }, "amount": { "type": "string", "example": "10000" }, "status": { "type": "string", "example": "completed" }, "ewalletCode": { "type": "string", "example": "DANA" }, "redirectUrl": { "type": "string", "example": "https://m.sandbox.dana.id/m/portal/cashier/checkout?bizNo=20240913111212800110166428801774762×tamp=1726198476396&originSourcePlatform=IPG&mid=216620040016026395535&sign=ae0XxUMldxGjS4oJDf3XuzWhx9fHYCz7Be%2BG8zUAWZAtc1axXlBSB4uzO%2FVX8IqvpIm5mZMCKwBWALPi8F2KHMpO566juhFvVxqpQ0%2B5v8w%2BdJngzMETKgcD6g6sY28V1sOR3BOy32CZQWxzRqVmvNX32Jdh5YHuuLepMnqdAWYPBcnTu6laj%2BcuHIEJoJXRX5n%2Fnp9UDQ6OBcE%2FX9CBKXmzIXGQ%2BDJWyO%2BBRZnoNmbzyUzhRvWOH13h3abmj7kDY33xpmwOiZoBAYNVq6TZnqbEXFQPPnTiV0NV7ry%2BCDOLbTMChcO0erurZZ%2FlJEltqIicp8WCIMcN%2BE5%2ForDKpQ%3D%3D&forceToH5=false" }, "expiredAt": { "type": "string", "example": "2024-09-13T11:35:36.296+07:00" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "error": {} } } ] } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Reference ID Not Found": { "value": "{\n \"status\": 401,\n \"error\": {\n \"code\": \"invalid_parameters_in_headers\",\n \"message\": \"Transaction ID not found\",\n \"action\": \"Please ensure that the transaction ID is correct\",\n \"reason\": \"We did not find any transaction with such ID\"\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": "Transaction ID not found" }, "action": { "type": "string", "example": "Please ensure that the transaction ID is correct" }, "reason": { "type": "string", "example": "We did not find any transaction with such ID" } } }, "metaData": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Payment" } } }, "data": {} } } } } } }, "deprecated": false, "tags": [ "Ewallet" ], "x-docs-page": "/brickcollect-acceptance/e-wallet/status-ewallet-payment", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v2/payments/gs", "x-brick-original-path": "/acceptance/ewallet/{id}" } }, "/v1/payments/checkout": { "post": { "summary": "Buat Sesi Halaman Checkout", "description": "Buat sesi Brick Checkout Page yang dihosting dan terima checkoutUrl yang dapat dibagikan dengan pelanggan. Gunakan Checkout Page bila Anda ingin Brick menghosting pengalaman pembayaran di seluruh metode yang didukung alih-alih membuat sendiri setiap pembayaran UI. Permintaan tersebut menentukan jumlah, mata uang, detail pelanggan, masa berlaku, dan konteks callback untuk rekonsiliasi nanti.", "operationId": "create-checkout-page-session", "parameters": [ { "name": "publicAccessToken", "in": "header", "description": "Pembawa `. periksa /getting-started/generate-public-access-token-jwt-token", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "externalId", "currency", "description" ], "properties": { "externalId": { "type": "string", "description": "Pengidentifikasi unik yang ditentukan penjual untuk sesi pembayaran" }, "currency": { "type": "string", "description": "Mata uang transaksi. Gunakan `IDR` untuk aliran Receive Money saat ini." }, "description": { "type": "string", "description": "label Checkout ditunjukkan kepada pelanggan dan digunakan untuk rekonsiliasi." }, "amount": { "type": "number", "description": "Jumlah pembayaran tetap. Jika dihilangkan, pembayaran mungkin berperilaku sebagai aliran jumlah terbuka.", "format": "double" }, "type": { "type": "string", "description": "Jenis pembayaran. Koleksi yang diuji mendukung `qris` dan `virtual_account`." } } }, "examples": { "Minimal body": { "value": { "externalId": "CO-1773723246580", "currency": "IDR", "description": "Gaming Voucher Free Amount" } }, "fixed amount": { "value": { "externalId": "CO-1773723246580", "currency": "IDR", "description": "Gaming Voucher", "amount": 12012, "type": "qris" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"data\": {\n \"id\": \"QyECa1OpjWJcyfzXOLT6HKCxAVoDzUs3\",\n \"externalId\": \"CO-1773723246580\",\n \"status\": \"CREATED\",\n \"checkoutUrl\": \"https://sandbox-checkout.onebrick.io/aiU5tkLQZeZzXXdgwZUenOyGgTf41mKqyXv9XS96yB4QE9lze2wuMFhfPH4jMC2%2B\",\n \"currency\": \"IDR\",\n \"amount\": null,\n \"type\": \"\",\n \"createdAt\": \"2026-03-17T04:54:06Z\",\n \"description\": \"Gaming Voucher Free Amount\"\n },\n \"errors\": null,\n \"hashcode\": \"38d4b6cc3dd7a6cbb400f08c3bed1228\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": "QyECa1OpjWJcyfzXOLT6HKCxAVoDzUs3" }, "externalId": { "type": "string", "example": "CO-1773723246580" }, "status": { "type": "string", "example": "CREATED" }, "checkoutUrl": { "type": "string", "example": "https://sandbox-checkout.onebrick.io/aiU5tkLQZeZzXXdgwZUenOyGgTf41mKqyXv9XS96yB4QE9lze2wuMFhfPH4jMC2%2B" }, "currency": { "type": "string", "example": "IDR" }, "amount": {}, "type": { "type": "string", "example": "" }, "createdAt": { "type": "string", "example": "2026-03-17T04:54:06Z" }, "description": { "type": "string", "example": "Gaming Voucher Free Amount" } } }, "errors": {}, "hashcode": { "type": "string", "example": "38d4b6cc3dd7a6cbb400f08c3bed1228" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false, "tags": [ "Halaman Checkout" ], "x-docs-page": "/brickcollect-acceptance/checkout-page/create-checkout-page-session", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v1/payments", "x-brick-original-path": "/checkout" } }, "/v1/payments/checkout/status": { "get": { "summary": "Status Checkout", "description": "Ambil status terbaru dari sesi Checkout Page yang dihosting. Gunakan endpoint ini untuk merekonsiliasi tautan pembayaran, pembayaran pesanan, atau kasus dukungan pelanggan ketika Anda memiliki referensi sesi checkout. Responsnya mengonfirmasi apakah sesi tersebut tertunda, berbayar, kedaluwarsa, gagal, atau siap untuk ditindaklanjuti di sistem Anda.", "operationId": "checkout-status", "parameters": [ { "name": "checkoutId", "in": "query", "description": "pengidentifikasi checkout yang dihasilkan Brick dikembalikan dari POST /v1/payments/checkout.", "schema": { "type": "string" } }, { "name": "externalId", "in": "query", "description": "periksa externalId", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Created": { "value": "{\n \"status\": 200,\n \"data\": {\n \"id\": \"7FxYAqSFSdEhjm0oNeHxe1rgYZuSqXtC\",\n \"status\": \"CREATED\",\n \"expiredAt\": \"2026-04-16T14:36:06+07:00\"\n },\n \"errors\": null,\n \"hashcode\": \"5e590c76269fb229d366fa2999f9e386\"\n}" }, "Completed": { "value": "{\n \"status\": 200,\n \"data\": {\n \"id\": \"HghbCHpb7cxdaOEZAQEHM5VOLC0zi6zp\",\n \"status\": \"COMPLETED\",\n \"expiredAt\": \"2026-04-16T15:00:37+07:00\",\n \"payment\": {\n \"transactionId\": \"WA_42a086804ad34987b2f39c55df42a337\",\n \"type\": \"EWALLET\",\n \"externalId\": \"COtestnih-13-004-36\",\n \"amount\": 12012,\n \"status\": \"PAID\",\n \"createdAt\": \"2026-04-16T14:45:43+07:00\",\n \"expiredAt\": \"2026-04-16T15:46:42+07:00\",\n \"paidAt\": \"2026-04-16T14:46:02+07:00\"\n }\n },\n \"errors\": null,\n \"hashcode\": \"9cd33853779a305657421b03f569ac0c\"\n}" }, "Expired": { "value": "{\n \"status\": 200,\n \"data\": {\n \"id\": \"7FxYAqSFSdEhjm0oNeHxe1rgYZuSqXtC\",\n \"status\": \"EXPIRED\",\n \"expiredAt\": \"2026-04-16T14:36:06+07:00\"\n },\n \"errors\": null,\n \"hashcode\": \"c77b91ef1f50acdb43a69ac69d438d0b\"\n}" }, "Opened": { "value": "{\n \"status\": 200,\n \"data\": {\n \"id\": \"iEOroy1CyeQlg8GImsE2XXpzYKYmacl6\",\n \"status\": \"OPENED\",\n \"expiredAt\": \"2026-04-16T15:25:56+07:00\"\n },\n \"errors\": null,\n \"hashcode\": \"111db3f243bd3da241b7f5aba7fefcef\"\n}" } }, "schema": { "oneOf": [ { "title": "Dibuat", "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": "7FxYAqSFSdEhjm0oNeHxe1rgYZuSqXtC" }, "status": { "type": "string", "example": "CREATED" }, "expiredAt": { "type": "string", "example": "2026-04-16T14:36:06+07:00" } } }, "errors": {}, "hashcode": { "type": "string", "example": "5e590c76269fb229d366fa2999f9e386" } } }, { "title": "Selesai", "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": "HghbCHpb7cxdaOEZAQEHM5VOLC0zi6zp" }, "status": { "type": "string", "example": "COMPLETED" }, "expiredAt": { "type": "string", "example": "2026-04-16T15:00:37+07:00" }, "payment": { "type": "object", "properties": { "transactionId": { "type": "string", "example": "WA_42a086804ad34987b2f39c55df42a337" }, "type": { "type": "string", "example": "EWALLET" }, "externalId": { "type": "string", "example": "COtestnih-13-004-36" }, "amount": { "type": "integer", "example": 12012, "default": 0 }, "status": { "type": "string", "example": "PAID" }, "createdAt": { "type": "string", "example": "2026-04-16T14:45:43+07:00" }, "expiredAt": { "type": "string", "example": "2026-04-16T15:46:42+07:00" }, "paidAt": { "type": "string", "example": "2026-04-16T14:46:02+07:00" } } } } }, "errors": {}, "hashcode": { "type": "string", "example": "9cd33853779a305657421b03f569ac0c" } } }, { "title": "Kedaluwarsa", "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": "7FxYAqSFSdEhjm0oNeHxe1rgYZuSqXtC" }, "status": { "type": "string", "example": "EXPIRED" }, "expiredAt": { "type": "string", "example": "2026-04-16T14:36:06+07:00" } } }, "errors": {}, "hashcode": { "type": "string", "example": "c77b91ef1f50acdb43a69ac69d438d0b" } } }, { "title": "Dibuka", "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "data": { "type": "object", "properties": { "id": { "type": "string", "example": "iEOroy1CyeQlg8GImsE2XXpzYKYmacl6" }, "status": { "type": "string", "example": "OPENED" }, "expiredAt": { "type": "string", "example": "2026-04-16T15:25:56+07:00" } } }, "errors": {}, "hashcode": { "type": "string", "example": "111db3f243bd3da241b7f5aba7fefcef" } } } ] } } } }, "401": { "description": "401", "content": { "text/plain": { "examples": { "Result": { "value": "{\n \"status\": 401,\n \"data\": null,\n \"errors\": {\n \"code\": \"token_used_in_headers\",\n \"message\": \"Please use live publicAccessToken in headers\",\n \"action\": \"Please generate valid public access token via /v2/payments/auth/token APIs or contact to Brick sales team\",\n \"reason\": \"publicAccessToken is used\"\n },\n \"hashcode\": \"7e5d2eee019ba728fa516ff2f05d599e\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 401, "default": 0 }, "data": {}, "errors": { "type": "object", "properties": { "code": { "type": "string", "example": "token_used_in_headers" }, "message": { "type": "string", "example": "Please use live publicAccessToken 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": "publicAccessToken is used" } } }, "hashcode": { "type": "string", "example": "7e5d2eee019ba728fa516ff2f05d599e" } } } } } }, "404": { "description": "404", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 404,\n \"data\": null,\n \"errors\": {\n \"code\": \"wrong_parameters_in_request\",\n \"message\": \"Please use the correct parameters in your request\",\n \"action\": \"Check your request for a mistake or missing parameter in your request\",\n \"reason\": \"Checkout not found\"\n },\n \"hashcode\": \"1b98c4593c1a65f7b29ba03f80e80092\"\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 404, "default": 0 }, "data": {}, "errors": { "type": "object", "properties": { "code": { "type": "string", "example": "wrong_parameters_in_request" }, "message": { "type": "string", "example": "Please use the correct parameters in your request" }, "action": { "type": "string", "example": "Check your request for a mistake or missing parameter in your request" }, "reason": { "type": "string", "example": "Checkout not found" } } }, "hashcode": { "type": "string", "example": "1b98c4593c1a65f7b29ba03f80e80092" } } } } } } }, "deprecated": false, "tags": [ "Halaman Checkout" ], "x-docs-page": "/brickcollect-acceptance/checkout-page/checkout-status", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "/v1/payments", "x-brick-original-path": "/checkout/status" } }, "/v2/ocr/bank-statement/extract": { "get": { "summary": "Ekstrak Rekening Koran OCR", "description": "Kirimkan file laporan bank yang didukung ke Brick OCR dan ambil hasil ekstraksi terstruktur untuk alur kerja Financial Insight. Gunakan endpoint ini ketika produk Anda membutuhkan data transaksi dari laporan PDF yang diunggah tanpa entri data manual. Responsnya dapat mendukung penjaminan, rekonsiliasi, pemeriksaan keterjangkauan, atau analisis keuangan setelah Anda memvalidasi jenis file dan izin pengguna.", "operationId": "extract-bank-statement-ocr", "parameters": [ { "name": "publicAccessToken", "in": "header", "description": "Token pembawa untuk otentikasi. Format: Pembawa ", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "files" ], "properties": { "files": { "type": "string", "description": "File laporan bank hanya dalam format PDF, ukuran maksimal 5 MB per file.", "format": "binary" }, "email": { "type": "string", "description": "Email tujuan untuk menerima notifikasi hasil OCR." }, "client_request_id": { "type": "string", "description": "ID yang dibuat klien untuk idempotensi/pelacakan. Direkomendasikan untuk mencegah pemrosesan duplikat." } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"status\": 200,\n \"error\": null,\n \"message\": \"\",\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Experience\"\n },\n \"data\": {\n \"transactions\": [\n {\n \"transaction_id\": \"{{transaction_id}}\",\n \"third_party_transaction_id\": \"\",\n \"status\": \"PROCESSING\",\n \"filename\": \"{{filename}}.pdf\"\n }\n ]\n }\n}" }, "Complete": { "value": "{\n \"status\": 200,\n \"error\": null,\n \"message\": \"\",\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Experience\"\n },\n \"data\": {\n \"transactions\": [\n {\n \"transaction_id\": \"{{transaction_id}}\",\n \"third_party_transaction_id\": \"\",\n \"status\": \"COMPLETE\",\n \"filename\": \"filename.pdf\"\n }\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 200, "default": 0 }, "error": {}, "message": { "type": "string", "example": "" }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Experience" } } }, "data": { "type": "object", "properties": { "transactions": { "type": "array", "items": { "type": "object", "properties": { "transaction_id": { "type": "string", "example": "{{transaction_id}}" }, "third_party_transaction_id": { "type": "string", "example": "" }, "status": { "type": "string", "example": "PROCESSING" }, "filename": { "type": "string", "example": "{{filename}}.pdf" } } } } } } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Missing Files": { "value": "{\n \"status\": 400,\n \"data\": null,\n \"error\": {\n \"code\": \"INVALID_REQUEST\",\n \"message\": \"Files are required\",\n \"action\": \"Please provide at least one file.\",\n \"reason\": \"No files found in form\"\n },\n \"metadata\": {\n \"source\": \"API\",\n \"entity\": \"Experience\"\n }\n}" } }, "schema": { "type": "object", "properties": { "status": { "type": "integer", "example": 400, "default": 0 }, "data": {}, "error": { "type": "object", "properties": { "code": { "type": "string", "example": "INVALID_REQUEST" }, "message": { "type": "string", "example": "Files are required" }, "action": { "type": "string", "example": "Please provide at least one file." }, "reason": { "type": "string", "example": "No files found in form" } } }, "metadata": { "type": "object", "properties": { "source": { "type": "string", "example": "API" }, "entity": { "type": "string", "example": "Experience" } } } } } } } } }, "deprecated": false, "tags": [ "OCR Rekening Koran" ], "x-docs-page": "/brickdata/ocr-bank-statement/extract-bank-statement-ocr", "x-zudoku-playground-enabled": true, "servers": [ { "url": "https://sandbox.onebrick.io", "description": "Sandbox Brick API" }, { "url": "https://api.onebrick.io", "description": "Produksi Brick API" } ], "security": [ { "sec0": [] } ], "x-brick-endpoint-base-path": "" } } }, "tags": [ { "name": "Autentikasi", "description": "Membuat dan mengelola token akses yang diperlukan oleh permintaan Brick API. Mulai di sini sebelum menguji titik akhir pembayaran, pencairan, QRIS, Virtual Account, Checkout Page, OCR, atau validasi akun di sandbox dan produksi." }, { "name": "Subakun B2C", "description": "Kelola sub-akun klien B2C, penyiapan kunci publik, dan rotasi kunci API untuk integrasi Brick multi-penyewa. Titik akhir ini membantu platform mengisolasi kredensial klien dan mengoperasikan sub-akun di bawah ruang kerja Brick utama." }, { "name": "Disbursement BI-FAST", "description": "Buat transfer bank BI-FAST waktu nyata melalui Brick Send Money. Gunakan tag ini ketika Anda memerlukan jalur pembayaran yang lebih cepat, detail bank penerima, informasi pengirim, referensi IDs, callbacks, dan pelacakan status." }, { "name": "Saldo", "description": "Periksa saldo Brick yang tersedia sebelum membuat pencairan, memproses pembayaran, atau merekonsiliasi dana operasional. Pemeriksaan saldo membantu sistem keuangan dan produk mencegah kegagalan dana yang tidak mencukupi." }, { "name": "Validasi Rekening Bank", "description": "Verifikasi detail rekening bank Indonesia sebelum menyimpan penerima manfaat atau memulai pembayaran. Validasi akun mengurangi kegagalan transfer, kesalahan ketik nomor rekening, dan masalah rekonsiliasi operasional." }, { "name": "Halaman Checkout", "description": "Membuat dan memantau sesi Brick Checkout Page yang dihosting. Checkout Page berguna ketika Anda menginginkan tautan pembayaran yang dapat dibagikan atau halaman pembayaran yang dihosting tanpa membuat sendiri setiap metode pembayaran UI." }, { "name": "Disbursement", "description": "Validasi penerima dan ambil status pencairan untuk alur kerja Brick Send Money. Gunakan endpoint ini dengan pembayaran Reguler atau BI-FAST untuk direkonsiliasi dengan pencairan Brick ID atau reference ID Anda sendiri." }, { "name": "Ewallet", "description": "Buat tautan pengalihan pembayaran Ewallet dan periksa status transaksi. Gunakan titik akhir ini ketika pelanggan membayar melalui aplikasi Ewallet yang didukung dan sistem Anda memerlukan pengalihan URL plus status rekonsiliasi." }, { "name": "Ledger", "description": "Ambil catatan buku besar transaksi untuk rekonsiliasi keuangan, tinjauan operasional, dan riwayat pembayaran. data Ledger membantu mencocokkan transaksi Brick dengan pesanan internal, laporan penyelesaian, dan catatan akuntansi." }, { "name": "OCR Rekening Koran", "description": "Kirimkan file laporan bank ke Brick OCR dan ambil data keuangan yang diekstrak. endpoint ini mendukung alur kerja Financial Insight yang memerlukan data transaksi terstruktur dari pernyataan yang diunggah." }, { "name": "QR Code Dinamis", "description": "Buat, uji, dan periksa Kode QRIS QR dinamis untuk pembayaran pelanggan. Kode QR dinamis dihasilkan per transaksi dan harus direkonsiliasi melalui callbacks atau penyelidikan status." }, { "name": "QR Code SNAP", "description": "Buat dan kueri pembayaran QRIS menggunakan titik akhir dan header yang kompatibel dengan SNAP. Gunakan titik akhir ini ketika integrasi Anda mengikuti standar SNAP Indonesia untuk token akses, tanda tangan, stempel waktu, dan alur QR MPM." }, { "name": "QR Code Statis", "description": "Ambil data pedagang QRIS statis dan periksa status pembayaran QR Code statis. Kode QR statis berguna untuk alur pembayaran yang disajikan pedagang di mana identitas QR digunakan kembali." }, { "name": "Disbursement Reguler", "description": "Buat pembayaran Brick Send Money standar ke rekening bank atau tujuan Ewallet yang didukung. Gunakan Disbursement Reguler ketika perutean BI-FAST real-time tidak diperlukan atau tidak tersedia." }, { "name": "Top Up", "description": "Tinjau opsi isi ulang yang tersedia dan riwayat isi ulang untuk mendanai saldo Brick. Titik akhir ini membantu tim operasi menyiapkan dana sebelum menjalankan alur kerja pencairan." }, { "name": "Bukti Transfer", "description": "Download dokumen bukti transfer untuk pencairan yang sudah selesai. Gunakan endpoint ini untuk dukungan pelanggan, bukti keuangan, jalur audit, dan alur kerja konfirmasi pembayaran." }, { "name": "Virtual Account Open VA", "description": "Hasilkan dan pantau pembayaran Open VA yang dapat digunakan kembali. Gunakan titik akhir ini ketika pelanggan dapat mentransfer jumlah fleksibel ke pengidentifikasi akun virtual yang sama dan sistem Anda memerlukan rekonsiliasi status Open VA.", "x-displayName": "Open VA" }, { "name": "Virtual Account Close VA", "description": "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.", "x-displayName": "Close VA" } ], "x-tagGroups": [ { "name": "Autentikasi", "tags": [ "Autentikasi" ] }, { "name": "Kirim Uang", "tags": [ "Top Up", "Saldo", "Disbursement", "Disbursement BI-FAST", "Disbursement Reguler", "Ledger", "Bukti Transfer" ] }, { "name": "Terima Uang", "tags": [ "Halaman Checkout", "Ewallet", "QR Code Dinamis", "QR Code Statis", "QR Code SNAP", "Virtual Account Open VA", "Virtual Account Close VA" ] }, { "name": "Wawasan Keuangan", "tags": [ "Validasi Rekening Bank", "OCR Rekening Koran" ] }, { "name": "Workspace", "tags": [ "Subakun B2C" ] } ] }