Skip to main content
GET
/
getDeposits
Get Deposits
curl --request GET \
  --url https://dashu.sa/api/external/getDeposits
{
  "success": true,
  "result": [
    {
      "Iban": "SA0000000000000000000000",
      "DepositId": 123123,
      "VendorId": 456456,
      "DepositReference": "123456789",
      "BankName": "Riyad Bank(RB)",
      "TotalValue": 53661.0089999999981955625116825103759765625,
      "DepositDate": "02/06/2024"
    },
    {
      "Iban": "SA0000000000000000000000",
      "DepositId": 123123,
      "VendorId": 456456,
      "DepositReference": "123456789",
      "BankName": "Riyad Bank(RB)",
      "TotalValue": 123.23102948723462873,
      "DepositDate": "01/06/2024"
    }
  ]
}

​
Query Parameters

​
apiKey
string
required
The API Key of your account.
​
test
boolean
Set this property to true to send the request to the development environment.
{
  "success": true,
  "result": [
    {
      "Iban": "SA0000000000000000000000",
      "DepositId": 123123,
      "VendorId": 456456,
      "DepositReference": "123456789",
      "BankName": "Riyad Bank(RB)",
      "TotalValue": 53661.0089999999981955625116825103759765625,
      "DepositDate": "02/06/2024"
    },
    {
      "Iban": "SA0000000000000000000000",
      "DepositId": 123123,
      "VendorId": 456456,
      "DepositReference": "123456789",
      "BankName": "Riyad Bank(RB)",
      "TotalValue": 123.23102948723462873,
      "DepositDate": "01/06/2024"
    }
  ]
}

​
Response properties

​
IsSuccess
boolean
required
The response status.
​
Message
string
required
The description of the response status.
​
ValidationErrors
array|null
required
List of validation errors (if any).
​
result
object
required

​
Error Codes

Here’s a list of possible error codes of this endpoint.
CodeDescription
1Missing or invalid api key