Authentication
Identify the credential and token flow required by the API family before calling protected endpoints.
Brick API References · Endpoint Contracts
Build against precise API contracts.
Move from authentication to final transaction status with the methods, paths, parameters, payloads, and response structures your implementation needs.
See the contract before you call it.
Confirm the environment, authentication flow, headers, request schema, and documented response for every operation.
✓
Method & path
Use the exact operation documented for the selected API family.
✓
Request schema
Validate required fields, types, headers, and reference values.
✓
Response & status
Map identifiers and confirm whether the state is intermediate or final.
Authentication example
GET /v2/payments/auth/token
Host: sandbox.onebrick.io
Authorization: Basic <credentials>
// Keep credentials on your server.
// Use the token flow documented
// for the API family you call.
Next:
1. Build the product request
2. Store the reference ID
3. Handle callback updates
4. Confirm final statusImplementation sequence
From credentials to a confirmed transaction outcome.
The reference is organized for implementation work: authenticate, construct the request, map the response, and handle asynchronous state changes.
01/ Authenticate
Authenticate with credentials from the correct environment.
Use server-side credentials and the authentication flow documented for the API family you are calling. Keep Sandbox and Production credentials separate.
02/ Create request
Build the request from the endpoint contract.
Confirm the HTTP method, path, headers, field types, required parameters, and example payload before sending a request.
03/ Map response
Map the response without assuming the first state is final.
Store your reference together with Brick identifiers, interpret documented response fields, and distinguish accepted or pending states from final outcomes.
04/ Confirm outcome
Confirm the final outcome through callbacks and status APIs.
Handle callback events idempotently and use the relevant status endpoint for reconciliation, investigation, or fallback when an event is delayed.
Reference coverage
The details engineers need while coding.
Use the API Reference alongside Sandbox testing and the broader Documentation guidance for production readiness.
Endpoint contracts
Review the method, path, request headers, query parameters, and body schema for each operation.
Example payloads
Use sanitized request and response examples to compare your implementation with the documented structure.
Response states
Map accepted, processing, completed, failed, and other documented states without treating intermediate responses as final.
Callbacks & status
Implement asynchronous event handling and status checks for reliable transaction updates and reconciliation.
Product API families
Navigate contracts for send money, Virtual Account, QRIS, e-wallet, Checkout Page, and shared transaction operations.
Reliable integration pattern
Treat payment status as a workflow, not one response.
A successful initial response may mean a request was accepted for processing. Reliable implementations preserve references and confirm the final outcome.
Use unique references
Keep a stable, searchable reference for each transaction and store it with the identifiers returned by Brick.
Process callbacks idempotently
Repeated events must not duplicate credits, debits, reconciliation entries, or customer notifications.
Use status APIs as confirmation
Check status for reconciliation, support investigation, or fallback when a callback is delayed.
Ready to implement with the exact contract?
Open the API Reference for endpoint-level details, or review the Documentation first when you still need product and setup context.