> For the complete documentation index, see [llms.txt](https://docs.bulkmail.shop/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bulkmail.shop/wallet.md).
# Wallet
Balance and payment operations
## GET /wallet/balance
> Get wallet balance
```json
{"openapi":"3.1.0","info":{"title":"BulkMail API","version":"2.0.0"},"tags":[{"name":"Wallet","description":"Balance and payment operations"}],"servers":[{"url":"https://bulkmail.shop/api/v2","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the dashboard."}},"responses":{"Unauthorized":{"description":"Authentication required or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"paths":{"/wallet/balance":{"get":{"tags":["Wallet"],"summary":"Get wallet balance","responses":{"200":{"description":"Current balance","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"balance":{"type":"number","format":"float"},"currency":{"type":"string"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## GET /wallet/transactions
> List transactions
```json
{"openapi":"3.1.0","info":{"title":"BulkMail API","version":"2.0.0"},"tags":[{"name":"Wallet","description":"Balance and payment operations"}],"servers":[{"url":"https://bulkmail.shop/api/v2","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the dashboard."}},"schemas":{"Transaction":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","enum":["deposit","purchase","refund","admin_adjustment"]},"amount":{"type":"number","format":"float"},"balance_after":{"type":"number","format":"float"},"description":{"type":"string"},"created_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer"},"total_pages":{"type":"integer"}}},"Error":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"responses":{"Unauthorized":{"description":"Authentication required or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/wallet/transactions":{"get":{"tags":["Wallet"],"summary":"List transactions","parameters":[{"name":"page","in":"query","schema":{"type":"integer","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","default":20}},{"name":"type","in":"query","schema":{"type":"string","enum":["deposit","purchase","refund","admin_adjustment"]}},{"name":"date_from","in":"query","schema":{"type":"string","format":"date"}},{"name":"date_to","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Transaction list","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## Create deposit
> Create a deposit using available payment gateways.\
> \
> \*\*Payment Methods:\*\*\
> \- \`heleket\` or \`crypto\` - Heleket crypto gateway\
> \- \`cryptomus\` - Cryptomus gateway\
> \- \`piprapay\` - PipraPay USD gateway
```json
{"openapi":"3.1.0","info":{"title":"BulkMail API","version":"2.0.0"},"tags":[{"name":"Wallet","description":"Balance and payment operations"}],"servers":[{"url":"https://bulkmail.shop/api/v2","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the dashboard."}},"responses":{"Unauthorized":{"description":"Authentication required or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"ValidationError":{"description":"Validation failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"paths":{"/wallet/deposit":{"post":{"tags":["Wallet"],"summary":"Create deposit","description":"Create a deposit using available payment gateways.\n\n**Payment Methods:**\n- `heleket` or `crypto` - Heleket crypto gateway\n- `cryptomus` - Cryptomus gateway\n- `piprapay` - PipraPay USD gateway\n","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["amount","gateway"],"properties":{"amount":{"type":"number","format":"float","minimum":0.4,"description":"Amount in USD"},"gateway":{"type":"string","enum":["heleket","crypto","cryptomus","piprapay"],"description":"Payment gateway"},"currency":{"type":"string","default":"USDT","description":"Crypto currency (for crypto gateways)"}}}}}},"responses":{"200":{"description":"Deposit created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"deposit_id":{"type":"integer"},"amount":{"type":"number","format":"float"},"payment_method":{"type":"string"},"status":{"type":"string"},"payment_url":{"type":"string","format":"uri","description":"Redirect user to this URL to complete payment"},"expires_at":{"type":"string","format":"date-time"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"422":{"$ref":"#/components/responses/ValidationError"}}}}}}
```
## GET /wallet/deposits
> List deposits
```json
{"openapi":"3.1.0","info":{"title":"BulkMail API","version":"2.0.0"},"tags":[{"name":"Wallet","description":"Balance and payment operations"}],"servers":[{"url":"https://bulkmail.shop/api/v2","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the dashboard."}},"schemas":{"Deposit":{"type":"object","properties":{"id":{"type":"integer"},"amount":{"type":"number","format":"float"},"status":{"type":"string","enum":["pending","completed","failed","cancelled"]},"payment_method":{"type":"string","enum":["crypto","cryptomus","piprapay"]},"payment_url":{"type":"string","format":"uri"},"created_at":{"type":"string","format":"date-time"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"per_page":{"type":"integer"},"total":{"type":"integer"},"total_pages":{"type":"integer"}}},"Error":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"responses":{"Unauthorized":{"description":"Authentication required or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/wallet/deposits":{"get":{"tags":["Wallet"],"summary":"List deposits","parameters":[{"name":"page","in":"query","schema":{"type":"integer","default":1}},{"name":"per_page","in":"query","schema":{"type":"integer","default":20}},{"name":"status","in":"query","schema":{"type":"string","enum":["pending","completed","failed","cancelled"]}}],"responses":{"200":{"description":"Deposit list","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Deposit"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## GET /wallet/deposits/{id}/status
> Check deposit status
```json
{"openapi":"3.1.0","info":{"title":"BulkMail API","version":"2.0.0"},"tags":[{"name":"Wallet","description":"Balance and payment operations"}],"servers":[{"url":"https://bulkmail.shop/api/v2","description":"Production server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key for authentication. Get your key from the dashboard."}},"responses":{"Unauthorized":{"description":"Authentication required or invalid","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"paths":{"/wallet/deposits/{id}/status":{"get":{"tags":["Wallet"],"summary":"Check deposit status","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Deposit status","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"data":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":"string"},"amount":{"type":"number","format":"float"},"payment_method":{"type":"string"}}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.bulkmail.shop/wallet.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.