Brick API Documentation
API

Check Disbursement Status using Reference ID

Use this status endpoint to retrieve the latest Send Money transaction state using the referenceId from your own system. This check helps reconcile payouts when your platform tracks transactions by internal reference, when callbacks are delayed, or when the initial create request returned an uncertain result.

Environment for Endpoint URL

Please Replace the environment in the URL with:

When the environment is sandbox, replace the {environment} with sandbox. so the URL will be https://sandbox.onebrick.io/v2/payments/gs

When the environment is production, replace the {environment} with api. so the URL will be https://api.onebrick.io/v2/payments/gs

Request parameters

Key ParametersData TypeDescription
publicAccessTokenStringOne time access-token generated using the auth token API
referenceIdStringClient Reference ID of specific transaction

Response parameters

Key ParametersData typeDescription
referenceIdStringReference ID given by end user
idStringTransaction id generated by brick
amountStringAmount of transaction
statusStringThe Status of transaction
createdAtTimestampTime when the transaction created
typeStringType of transaction
bankAccountNoNumberAccount number of beneficiary
bankShortCodeStringBank Short Code
bankAccountHolderNameStringDescription that filled related to fund transfer
bankNameStringBeneficiary bank name
Last modified on