get https://sandbox.onebrick.io/v2/payments/gs/disbursements/
This API helps you to retrieve the past disbursement
Note: A real transaction is only available in a production environment.
Request parameters
| Key Parameters | Data Type | Description |
|---|---|---|
| publicAccessToken | String | One time access-token generated using the auth token API |
| id | String | Unique identifier of each disbursement transaction |
Response parameters
| Key Parameters | Data type | Description |
|---|---|---|
| id | String | Unique identifier |
| type | String | Type of transaction |
| status | String | The status of disbursement |
| createdAt | TimeStamp | Time at which the response was created. |
| failureReason | String | Reason of failed transaction and will only be shown when the transaction is failed. |
| amount | Integer | Amount of money to be disbursed |
| referenceId | String | A unique reference ID as a unique identifier |
| description | String | An arbitrary string attached to the object. Often useful for displaying to users what the transaction was for. Description length limit is 255 chars. |
| type | String | Currently only support bank transfer |
| bankAccountNo | String | Account number of the user |
| bankShortCode | String | Institution short code of the user |
| bankAccountHolderName | String | Account name that the funds are intended to be sent to. |
| bankName | String | Name of the Institutions |
| settlementStatus | String | Status of Transaction Settlement |