Regular Disbursement

Server

Regular Disbursement

POST

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

/disbursements

Sending funds via Brick allows you to perform digital fund transfers, and Brick currently supports fund transfers to financial accounts and e-wallets. Before you can send out funds, you will need to make sure that there are sufficient funds in your account with Brick for disbursements to be possible. To do that, deposit funds to your Brick account.

Before using this API, it is suggested to use Account Verification API to validate the recipient's account.

Regular Disbursement › Request Body

referenceId

string · required

A unique reference ID as a unique identifier

Default: test-1

description

string · required

An arbitrary string attached to the object. Often useful for displaying to users what the transaction was for. Description length limit is 1000 chars.

Default: test-disbursement-1

amount

integer · int32 · required

Amount that you would like to send

Default: 29999

object · required

recipientEmail

string

Regular Disbursement › Responses

200

No data returned

POST/disbursements

curl https://sandbox.onebrick.io/v2/payments/general/disbursements \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "referenceId": "test-1",
  "description": "test-disbursement-1",
  "amount": 29999,
  "disbursementMethod": {
    "type": "bank_transfer",
    "bankAccountNo": "112233445",
    "bankShortCode": "MANDIRI",
    "bankAccountHolderName": "PROD ONLY"
  },
  "recipientEmail": "recipientEmail"
}'

Example Request Body

{
  "referenceId": "test-1",
  "description": "test-disbursement-1",
  "amount": 29999,
  "disbursementMethod": {
    "type": "bank_transfer",
    "bankAccountNo": "112233445",
    "bankShortCode": "MANDIRI",
    "bankAccountHolderName": "PROD ONLY"
  },
  "recipientEmail": "recipientEmail"
}

json

Example Responses

{
  "status": 200,
  "data": {
    "message": "We have received your request and are processing it, please check your callback URL for transaction status",
    "id": "asdasd123123asdasdasd",
    "type": "disbursement",
    "attributes": {
      "referenceId": "test-disbursement-1",
      "description": "test-disbursement-1",
      "amount": "100000",
			"feeAmount":"2000"
      "status": "processing",
      "settlementStatus":"null",
      "createdAt": "2022-07-21T13:49:39.752+07:00",
      "disbursementMethod": {
        "type": "bank_transfer",
        "bankAccountNo": "12345678",
        "bankShortCode": "BCA",
        "bankAccountHolderName": "PROD ONLY"
      }
    }
  },
  "metaData": {
    "source": "API",
    "entity": "Payment"
  },
  "error": null
}

json

application/json

BIFAST Disbursement Transfer Proof

Regular Disbursement

POST

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

/disbursements

Before using this API, it is suggested to use Account Verification API to validate the recipient's account.

Regular Disbursement › Request Body

referenceId

string · required

A unique reference ID as a unique identifier

Default: test-1

description

string · required

An arbitrary string attached to the object. Often useful for displaying to users what the transaction was for. Description length limit is 1000 chars.

Default: test-disbursement-1

amount

integer · int32 · required

Amount that you would like to send

Default: 29999

object · required

recipientEmail

string

Regular Disbursement › Responses

200

No data returned