get https://{environment}.onebrick.io/v2/payments/gs/disbursements/transaction?referenceId=referenceId (COPY)
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/bifast-disbursements
When the environment is production, replace the {environment} with api. so the URL will be https://api.onebrick.io/v2/payments/gs/bifast-disbursements
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 |
Additional Request Parameters
| Key Parameters | Data Type | Description | Limitation |
|---|---|---|---|
| name | String | Name of the user that send the money | 1. Alpha Numeric 2. Space Allowed 3. Max 40 Characters |
| identityType | String | Allowed Value only KTP/SIM/KITAS/NPWP | Allowed Value only KTP/SIM/KITAS/NPWP |
| identityNumber | String | Identity Number of the User | 1. Alpha Numeric 2. Min 10 characters 3. Max 16 Characters |
| countryCode | String | Country Code based on the user | Allowed Value are 2 all caps characters |
| provinceCode | String | Province Code based on the user | Allowed Value are 2 all caps characters |
| cityCode | String | City Code based on the user | Allowed Value are 4 all caps characters |
| jobCode | String | Job Code based on the user | Allowed Value are 4 all caps characters |
| address | String | Address of the user | 1. Alpha Numeric 2. Space Allowed 3. Max 40 Characters |
| placeOfBirth | String | Place of the user birth | 1. Alpha Numeric 2. Space allowed 3. Max 40 Characters |
| dateOfBirth | String | Date of Birth of the user | YYYY-MM-DD Format |
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 |
Additional Response Parameters
| Key Parameters | Data Type | Description |
|---|---|---|
| name | String | Name of the user that send the money |
| identityType | String | Allowed Value only KTP/SIM/KITAS/NPWP |
| identityNumber | String | Identity Number of the User |
| countryCode | String | Country Code based on the user |
| provinceCode | String | Province Code based on the user |
| cityCode | String | City Code based on the user |
| jobCode | String | Job Code based on the user |
| address | String | Address of the user |
| placeOfBirth | String | Place of the user birth |
| dateOfBirth | String | Date of Birth of the user |