Get Deposit

GET /v1/deposits/{depositId}

Path parameters

depositId string(uuid) Required

The id of the deposit.

Responses

200 application/json

Request succeeded.
Hide response attributes Show response attributes object
- id string(uuid)
  
  The unique id.
- createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
- modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
- date string(date) Required
  
  The date the deposit was received.
- amount number(currency) Required
  
  The amount of the deposit.
- received boolean
  
  If the deposit has been received or not.
- interest boolean
  
  If the deposit accumulates interest.
- held boolean
  
  If the deposit is held or not.
- heldBy string | null
  
  Who the deposit is held by.
- direct boolean
  
  If the deposit is direct or not.
- reference string | null
  
  The reference number for the deposit.
400 application/json

Invalid request. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
401 application/json

Unauthorized. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
403 application/json

Permission denied. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
404 application/json

Not found. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.

GET /v1/deposits/{depositId}

curl \
 --request GET 'https://api.lwolf.com/backoffice/v1/deposits/{depositId}'

Response examples (200)

{
  "id": "string",
  "createdTimestamp": "string",
  "modifiedTimestamp": "string",
  "date": "string",
  "amount": 0,
  "received": true,
  "interest": true,
  "held": true,
  "heldBy": "string",
  "direct": true,
  "reference": "string"
}

Response examples (400)

{
  "id": "string",
  "code": 0,
  "message": "string",
  "details": [
    "string"
  ]
}

Response examples (401)

{
  "id": "string",
  "code": 0,
  "message": "string",
  "details": [
    "string"
  ]
}

Response examples (403)

{
  "id": "string",
  "code": 0,
  "message": "string",
  "details": [
    "string"
  ]
}

Response examples (404)

{
  "id": "string",
  "code": 0,
  "message": "string",
  "details": [
    "string"
  ]
}