GET
/
getDeposits

​
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.

​
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
Iban
string
required

The IBAN number used to transfer the deposit.

DepositId
integer
required

A unique number indicates the Deposit in DashPay system.

VendorId
string
required

A unique number indicates the Vendor account in DashPay system.

DepositReference
string
required

A unique value indicates the Deposit in DashPay system.

BankName
string
required

Name of the bank that owns the IBAN number.

TotalValue
string
required

The total amount sent to the bank account.

DepositDate
string
required

The date of issuing the Deposit process.

​
Error Codes

Here’s a list of possible error codes of this endpoint.

CodeDescription
1Missing or invalid api key
Make RefundGet Deposit Details