Check Status

Server

Validate recipients and retrieve disbursement status for Brick Send Money workflows. Use these endpoints with Regular or BI-FAST payouts to reconcile by Brick disbursement ID or your own reference ID.

Check Disbursement Status using Disbursement ID

GET

https://sandbox.onebrick.io

/v2/payments/gs/disbursements/{disbursementId}

publicAccessToken (header)

Retrieve the latest disbursement status by Brick disbursement ID. Use this endpoint after creating a Regular or BI-FAST payout when your system has stored the Brick-generated disbursement identifier. The response helps support, operations, and reconciliation systems confirm whether a payout is processing, completed, failed, or requires further investigation.

Check Disbursement Status using Disbursement ID › path Parameters

disbursementId

string · required

Disbursement ID of the transaction

Check Disbursement Status using Disbursement ID › Responses

200

status

integer

Default: 0

object

error

Example Responses

{
    "status": 200,
    "data": {
        "message": "We have successfuly retrieve your disbursement",
        "id": "c8836b555a8842b2ac20fef1a",
        "type": "disbursement",
        "attributes": {
            "referenceId": "182y1841",
            "description": "Disbursement",
            "amount": "29999",
            "status": "failed",
            "createdAt": "2030-12-22T10:12:08.000+07:00",
            "disbursementMethod": {
                "type": "bank_transfer",
                "bankAccountNo": "78472",
                "bankShortCode": "MANDIRI",
                "bankAccountHolderName": "Test",
                "bankName": "Bank Mandiri"
            },
            "errorCode": "",
            "errorReason": ""
        }
    },
    "metaData": {
        "source": "API",
        "entity": "Payment"
    },
    "error": null
}

json

application/json

Check Disbursement Status using Reference ID

GET

https://sandbox.onebrick.io

/v2/payments/gs/disbursements/transaction

publicAccessToken (header)

Retrieve the latest disbursement status by your client-provided reference ID. Use this endpoint when internal orders, payout batches, or support cases are keyed by your own reference instead of the Brick disbursement ID. The response connects your business transaction to Brick payout state for reconciliation and customer communication.

Check Disbursement Status using Reference ID › query Parameters

referenceId

string

Reference ID from given from Client Side

Check Disbursement Status using Reference ID › Responses

200