Disbursement

Server

Download schema

Disbursement Account Validation

GET

https://sandbox.onebrick.io/v2/payments/general

/bank-account-validation

Validate a recipient bank account before creating a disbursement to reduce failed transfers and misdirected payouts.

Disbursement Account Validation › query Parameters

accountNumber

integer · int32 · required

The bank account number to be verified.

Default: 151601000313306

bankShortCode

string · required

The short code of the bank institution. Refer to the Supported Banks List for valid codes.

Default: BRI

Disbursement Account Validation › Headers

activityId

string

Optional tracking identifier provided by the client. If omitted, Brick will automatically generate a unique activityId. This value is returned in the response for end-to-end transaction tracing.

Disbursement Account Validation › Responses

200

status

integer

Default: 0

object

error

Check Disbursement Status using Disbursement ID

GET

https://sandbox.onebrick.io/v2/payments/general

/disbursements/{disbursementId}

Use this endpoint to check a disbursement status by Disbursement ID.

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

GET/disbursements/{disbursementId}

curl https://sandbox.onebrick.io/v2/payments/general/disbursements/:disbursementId

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/general

/disbursements/transaction

Use this endpoint to check a disbursement status by client-provided Reference ID.

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

status

integer

Default: 0

object

error

GET/disbursements/transaction

curl https://sandbox.onebrick.io/v2/payments/general/disbursements/transaction

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

Balance BIFAST Disbursement

Disbursement Account Validation

GET

https://sandbox.onebrick.io/v2/payments/general

/bank-account-validation

Validate a recipient bank account before creating a disbursement to reduce failed transfers and misdirected payouts.

Disbursement Account Validation › query Parameters

accountNumber

integer · int32 · required

The bank account number to be verified.

Default: 151601000313306

bankShortCode

string · required

The short code of the bank institution. Refer to the Supported Banks List for valid codes.

Default: BRI

Disbursement Account Validation › Headers

activityId

string

Optional tracking identifier provided by the client. If omitted, Brick will automatically generate a unique activityId. This value is returned in the response for end-to-end transaction tracing.

Disbursement Account Validation › Responses

200

status

integer

Default: 0

object

error

Check Disbursement Status using Disbursement ID

GET

https://sandbox.onebrick.io/v2/payments/general

/disbursements/{disbursementId}

Use this endpoint to check a disbursement status by Disbursement ID.

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

Check Disbursement Status using Reference ID

GET

https://sandbox.onebrick.io/v2/payments/general

/disbursements/transaction

Use this endpoint to check a disbursement status by client-provided Reference ID.

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

status

integer

Default: 0

object

error