> For the complete documentation index, see [llms.txt](https://docs.terragon.io/documents/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.terragon.io/documents/terragon-api-document/deposit.md).

# Deposit

Player deposit operations

## List deposits

> Retrieve a list of player's deposit transactions

```json
{"openapi":"3.0.0","info":{"title":"Terragon API Document","version":"1.0.0"},"tags":[{"name":"Deposit","description":"Player deposit operations"}],"servers":[{"url":"https://api.terragon.io/player/api","description":"Staging server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"last_page":{"type":"integer","description":"Last page number"},"per_page":{"type":"integer","description":"Number of items per page"},"total":{"type":"integer","description":"Total number of items"},"data":{"type":"array","description":"Collection of items for the current page","items":{"type":"object"}}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}}}}},"paths":{"/v1/deposits":{"get":{"tags":["Deposit"],"summary":"List deposits","description":"Retrieve a list of player's deposit transactions","operationId":"listDeposits","parameters":[{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"per_page","in":"query","required":false,"description":"Number of items per page","schema":{"type":"integer","default":10}},{"name":"status","in":"query","required":false,"description":"Filter by deposit status","schema":{"type":"string","enum":["pending","completed","failed","rejected"]}}],"responses":{"200":{"description":"Deposits retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationMeta"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## Create new deposit

> Initiate a new deposit transaction

```json
{"openapi":"3.0.0","info":{"title":"Terragon API Document","version":"1.0.0"},"tags":[{"name":"Deposit","description":"Player deposit operations"}],"servers":[{"url":"https://api.terragon.io/player/api","description":"Staging server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DepositTransaction":{"type":"object","properties":{"id":{"type":"integer","description":"Deposit ID"},"player_id":{"type":"integer","description":"Player ID"},"payment_option_id":{"type":"integer","description":"ID of the payment option used"},"amount":{"type":"number","format":"float","description":"Deposit amount"},"currency_code":{"type":"string","description":"Currency code"},"status":{"type":"string","enum":["pending","completed","failed","rejected"],"description":"Deposit status"},"created_at":{"type":"string","format":"date-time","description":"Deposit creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Deposit last update timestamp"}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}}},"ValidationError":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Validation errors by field"}}}}},"paths":{"/v1/deposits":{"post":{"tags":["Deposit"],"summary":"Create new deposit","description":"Initiate a new deposit transaction","operationId":"createDeposit","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_option_id","amount"],"properties":{"payment_option_id":{"type":"integer","description":"ID of the payment option to use"},"amount":{"type":"number","format":"float","description":"Deposit amount"},"currency_code":{"type":"string","description":"Currency code (if not using default)"},"bonus_code":{"type":"string","description":"Bonus code to apply to this deposit (optional)"}}}}}},"responses":{"201":{"description":"Deposit initiated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositTransaction"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Validation errors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError"}}}}}}}}}
```

## Get deposit details

> Retrieve details of a specific deposit

```json
{"openapi":"3.0.0","info":{"title":"Terragon API Document","version":"1.0.0"},"tags":[{"name":"Deposit","description":"Player deposit operations"}],"servers":[{"url":"https://api.terragon.io/player/api","description":"Staging server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"DepositTransaction":{"type":"object","properties":{"id":{"type":"integer","description":"Deposit ID"},"player_id":{"type":"integer","description":"Player ID"},"payment_option_id":{"type":"integer","description":"ID of the payment option used"},"amount":{"type":"number","format":"float","description":"Deposit amount"},"currency_code":{"type":"string","description":"Currency code"},"status":{"type":"string","enum":["pending","completed","failed","rejected"],"description":"Deposit status"},"created_at":{"type":"string","format":"date-time","description":"Deposit creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Deposit last update timestamp"}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}}}}},"paths":{"/v1/deposits/{id}":{"get":{"tags":["Deposit"],"summary":"Get deposit details","description":"Retrieve details of a specific deposit","operationId":"getDepositDetails","parameters":[{"name":"id","in":"path","required":true,"description":"Deposit ID","schema":{"type":"integer"}}],"responses":{"200":{"description":"Deposit details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositTransaction"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Deposit not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```

## List payment options

> Retrieve available payment options for deposits

```json
{"openapi":"3.0.0","info":{"title":"Terragon API Document","version":"1.0.0"},"tags":[{"name":"Deposit","description":"Player deposit operations"}],"servers":[{"url":"https://api.terragon.io/player/api","description":"Staging server"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"last_page":{"type":"integer","description":"Last page number"},"per_page":{"type":"integer","description":"Number of items per page"},"total":{"type":"integer","description":"Total number of items"},"data":{"type":"array","description":"Collection of items for the current page","items":{"type":"object"}}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}}}}},"paths":{"/v1/payment-options":{"get":{"tags":["Deposit"],"summary":"List payment options","description":"Retrieve available payment options for deposits","operationId":"listPaymentOptions","parameters":[{"name":"currency_code","in":"query","required":false,"description":"Filter by currency code","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination","schema":{"type":"integer","default":1}},{"name":"per_page","in":"query","required":false,"description":"Number of items per page","schema":{"type":"integer","default":10}}],"responses":{"200":{"description":"Payment options retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginationMeta"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}}}
```