Create Deposit

POST /v1/transactions/{transactionId}/deposits

Path parameters

transactionId string(uuid) Required

The id of the transaction.

application/json

Body

The deposit to create.

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.

Responses

200

OK
201 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.
409 application/json

Conflict. 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.
422 application/json

Validation failed. 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.

POST /v1/transactions/{transactionId}/deposits

curl \
 --request POST 'https://api.lwolf.com/backoffice/v1/transactions/{transactionId}/deposits' \
 --header "Content-Type: application/json" \
 --data '{"id":"string","date":"string","held":true,"amount":0,"direct":true,"heldBy":"string","interest":true,"received":true,"reference":"string","createdTimestamp":"string","modifiedTimestamp":"string"}'

Request example

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

Response examples (201)

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

Response examples (400)

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

Response examples (401)

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

Response examples (403)

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

Response examples (404)

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

Response examples (409)

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

Response examples (422)

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