# List deposits Returns incoming payments detected for your Axiym accounts. Deposits are accepted only from `ACTIVE` entries in your address book. Use the optional filters to narrow the results by account or deposit status. Product: Account API API reference version: 0.3.0 (current) OpenAPI contract: https://docs.axiym.io/openapi/account-api/0.3.0.yaml Canonical page: https://docs.axiym.io/account-api/api-reference/0.3.0/deposits/listDeposits [Complete reference with related definitions](/account-api/api-reference/0.3.0/deposits/listDeposits.full.md) ## GET /deposits ## Servers ```json [ { "url": "https://partner-api.sandbox.axiym.io/api/v1", "description": "Sandbox" }, { "url": "https://partner-api.axiym.io/api/v1", "description": "Production" } ] ``` ## Authentication ```json { "security": [ { "Default": [] } ], "securitySchemes": { "Default": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } ``` ## Parameters ### header: X-Request-Id ```json { "name": "X-Request-Id", "in": "header", "required": false, "description": "Optional client-generated request identifier (UUID recommended) for end-to-end tracing.\n\nAxiym echoes it in the `X-Request-Id` response header and records it in logs. Quote it when contacting support. If omitted, Axiym generates one.", "schema": { "type": "string", "format": "uuid", "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } } ``` ### query: first ```json { "name": "first", "in": "query", "description": "Maximum number of items to return (page size).", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20, "examples": [ 20 ] } } ``` ### query: after ```json { "name": "after", "in": "query", "description": "Cursor for the next page, from the previous response's pageInfo.endCursor.", "schema": { "type": "string", "examples": [ "eyJvZmZzZXQiOjI1fQ==" ] } } ``` ### query: accountId ```json { "name": "accountId", "in": "query", "description": "Filter by account.", "schema": { "type": "string", "format": "uuid", "examples": [ "8f1d4a2c-3b5e-4c7a-9d1f-2a6b8c0e4d3a" ] } } ``` ### query: status ```json { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/DepositStatus", "examples": [ "COMPLETED" ] }, "description": "Filter by status." } ``` ## Responses ### 200 ```json { "description": "Page of deposits.", "content": { "application/json": { "schema": { "type": "object", "required": [ "nodes", "pageInfo" ], "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/Deposit" } }, "pageInfo": { "$ref": "#/components/schemas/PageInfo" } } } } } } ``` ### 400 ```json { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code, duplicated in the body." }, "message": { "type": "string", "description": "Human-readable message describing the error." }, "errors": { "type": [ "object", "null" ], "properties": { "message": { "type": "string" } }, "description": "Additional error details; null when there are none." } }, "required": [ "code", "message", "errors" ] }, "examples": { "Malformed JSON body": { "summary": "Malformed JSON body", "value": { "code": 400, "message": "Bad Request", "errors": { "message": "Failed to parse the request body as JSON: expected value at line 1 column 5" } } }, "Generic": { "summary": "Generic", "value": { "code": 400, "message": "Invalid cursor", "errors": null } } } } }, "headers": { "X-Request-Id": { "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "schema": { "type": "string", "format": "uuid", "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } } } } ``` ### 401 ```json { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code, duplicated in the body." }, "message": { "type": "string", "description": "Human-readable message describing the error." }, "errors": { "type": [ "object", "null" ], "description": "Additional error details; null when there are none." } }, "required": [ "code", "message", "errors" ] }, "examples": { "Example 1": { "summary": "Example 1", "value": { "code": 401, "message": "Unauthorized", "errors": null } } } } }, "headers": { "X-Request-Id": { "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "schema": { "type": "string", "format": "uuid", "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } } } } ``` ### 403 ```json { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code, duplicated in the body." }, "message": { "type": "string", "description": "Human-readable message describing the error." }, "errors": { "type": [ "object", "null" ], "description": "Additional error details; null when there are none." } }, "required": [ "code", "message", "errors" ] }, "examples": { "Example 1": { "summary": "Example 1", "value": { "code": 403, "message": "Forbidden", "errors": null } } } } }, "headers": { "X-Request-Id": { "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "schema": { "type": "string", "format": "uuid", "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } } } } ``` ### 422 ```json { "description": "The request could not be processed. Two variants share this status: a validation failure, where `errors` is an object keyed by field name, and a business rejection, where `errors` is null and `message` states the reason (e.g. `Documents Not Accepted` when uploading to an already decided onboarding application, or the generic `Unprocessable Request`).", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code, duplicated in the body." }, "message": { "type": "string", "description": "`Invalid Parameters` for validation failures; the rejection reason otherwise." }, "errors": { "type": [ "object", "null" ], "description": "Validation failures: object keyed by field name (camelCase); each value is either an array of ValidationError records (leaf), a nested object for struct fields, or an object keyed by array index for list fields. Business rejections: null.", "additionalProperties": { "$ref": "#/components/schemas/ValidationFieldErrors" } } }, "required": [ "code", "message", "errors" ] }, "examples": { "Flat field errors": { "summary": "Flat field errors", "value": { "code": 422, "message": "Invalid Parameters", "errors": { "legalEntityName": [ { "code": "length", "message": null, "params": { "value": "", "min": 1 } } ], "currency": [ { "code": "invalid_currency", "message": null, "params": { "value": "ZZZ" } } ] } } }, "Nested struct errors": { "summary": "Nested struct errors", "value": { "code": 422, "message": "Invalid Parameters", "errors": { "legalAddress": { "country": [ { "code": "invalid_country", "message": null, "params": { "value": "INVALID" } } ], "postalCode": [ { "code": "length", "message": null, "params": { "value": "", "min": 1 } } ] } } } }, "List item errors": { "summary": "List item errors", "value": { "code": 422, "message": "Invalid Parameters", "errors": { "authorizedDirectors": { "0": { "firstName": [ { "code": "length", "message": null, "params": { "value": "", "min": 1 } } ], "email": [ { "code": "email", "message": null, "params": { "value": "not-an-email" } } ] } } } } }, "Custom validator": { "summary": "Custom validator", "value": { "code": 422, "message": "Invalid Parameters", "errors": { "disbursementAccount": [ { "code": "disbursement_account_required", "message": null, "params": { "value": null } } ] } } }, "Business rejection": { "summary": "Business rejection", "value": { "code": 422, "message": "Documents Not Accepted", "errors": null } } } } }, "headers": { "X-Request-Id": { "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "schema": { "type": "string", "format": "uuid", "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } } } } ``` ### 500 ```json { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "description": "HTTP status code, duplicated in the body." }, "message": { "type": "string", "description": "Human-readable message describing the error." }, "errors": { "type": [ "object", "null" ], "description": "Additional error details; null when there are none." } }, "required": [ "code", "message", "errors" ] }, "examples": { "Example 1": { "summary": "Example 1", "value": { "code": 500, "message": "Internal Error", "errors": null } } } } }, "headers": { "X-Request-Id": { "description": "Unique id of this request (echoed from the request, or generated when omitted). Recorded in Axiym logs — quote it when contacting support about a failed request.", "schema": { "type": "string", "format": "uuid", "examples": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } } } } ``` ## Operation metadata ```json { "tags": [ "Deposits" ], "operationId": "listDeposits" } ``` ## Referenced schemas Fetch the relevant schema to inspect its fields, constraints and related types. - [`#/components/schemas/DepositStatus`](/account-api/api-reference/0.3.0/schemas/DepositStatus.md) - [`#/components/schemas/Deposit`](/account-api/api-reference/0.3.0/schemas/Deposit.md) - [`#/components/schemas/PageInfo`](/account-api/api-reference/0.3.0/schemas/PageInfo.md) - [`#/components/schemas/ValidationFieldErrors`](/account-api/api-reference/0.3.0/schemas/ValidationFieldErrors.md)