Check Disbursement Status using Reference ID

This API enables you to check the transaction status before and after created using Reference ID given by Client

📘

Environment for End Point URL

Please Replace the environment in the URL with:

When the environtment 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 Parameters

Data Type

Description

publicAccessToken

String

One time access-token generated using the auth token API

referenceId

String

Client Reference ID of specific transaction

Response parameters

Key Parameters

Data type

Description

referenceId

String

Reference ID given by end user

id

String

Transaction id generated by brick

amount

String

Amount of transaction

status

String

The Status of transaction

createdAt

Timestamp

Time when the transaction created

type

String

Type of transaction

bankAccountNo

Number

Account number of beneficiary

bankShortCode

String

Bank Short Code

bankAccountHolderName

String

Description that filled related to fund transfer

bankName

String

Beneficiary bank name

Language
Credentials
Header
Click Try It! to start a request and see the response here!