| Deposit summaries |
| GET /api/v2/pay/deposit_summaries |
| Header name | Description |
|---|---|
|
Cookie required |
Login session cookie |
|
Provision required |
Web/Mobile/API Provision UUID |
| Param name | Description |
|---|---|
|
start_date required |
lower bound for deposit date. Expects format YYYY-MM-DD Validations:
|
|
end_date required |
upper bound for deposit date. Expects format YYYY-MM-DD Validations:
|
All deposit summaries
| Param name | Description |
|---|---|
|
data required |
deposit summary Validations:
|
|
data[id] required |
ID of the transaction Validations:
|
|
data[type] required |
Type of the charge Validations:
|
|
data[attributes] required |
Attributes of the deposit summary Validations:
|
|
data[attributes][id] required |
ID of the transaction Validations:
|
|
data[attributes][DepositID] required |
ID of the deposit Validations:
|
|
data[attributes][CreditID] required |
ID of the credit Validations:
|
|
data[attributes][DepositDate] required |
date of the deposit Validations:
|
|
data[attributes][From] required |
empty string Validations:
|
|
data[attributes][Description] required |
description of the transaction Validations:
|
|
data[attributes][GrossAmount] required |
amount of the transaction Validations:
|
|
data[attributes][NetAmount] required |
net amount of the transaction Validations:
|
Unauthorized
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Not Found
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Unprocessable Entity
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
Internal Server Error
| Param name | Description |
|---|---|
|
errors required |
Errors returned by request Validations:
|
|
errors[error] required |
Why the request failed Validations:
|
|
errors[status] required |
HTTP response code Validations:
|
| Code | Description |
|---|---|
| 404 | Data source query failed |
| 422 | Invalid parameter(s) |
| 422 | Provision header missing |
| 422 | Invalid provision |
| 422 | Under maintenance |
| 422 | Incorrect host for provision |
| 422 | Establishing session failed |
| 422 | Privilege to perform the action was not found |
| 422 | Not logged in |
| 422 | Provision does not match logged in provision |
| 422 | The start date or end date is invalid |
| 422 | Start date cannot be greater than the end date |
| 500 | No connection to data source |