> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gnosispay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a deposit

> Retrieves an on-chain deposit by ID, including its current review status
and transaction details.

Deposit processing is asynchronous. Treat `pending` as non-final and use a
webhook or this endpoint to observe the final status.



## OpenAPI

````yaml https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/deposits/{deposit_id}
openapi: 3.1.0
info:
  title: Gnosis Pay Partner API
  version: 1.0.0
  description: >-
    Server-to-server API for onboarding users, creating accounts and cards,
    moving

    funds, and managing the card lifecycle. Call this API only from a trusted

    backend. Every request requires a partner access token, and every resource
    is

    scoped to the authenticated partner.
servers:
  - url: https://core.prod.gnosispay.com/partner-api
    description: Production
    variables: {}
  - url: https://core.sandbox.gnosispay.in/core
    description: Sandbox
    variables: {}
security:
  - BearerAuth: []
tags:
  - name: Accounts
  - name: Cards
  - name: Card transactions
  - name: KYC
  - name: Deposits
  - name: Withdrawals
  - name: PCI
  - name: 3DS
  - name: Webhooks
paths:
  /v1/deposits/{deposit_id}:
    get:
      tags:
        - Deposits
      summary: Get a deposit
      description: >-
        Retrieves an on-chain deposit by ID, including its current review status

        and transaction details.


        Deposit processing is asynchronous. Treat `pending` as non-final and use
        a

        webhook or this endpoint to observe the final status.
      operationId: deposits.get.v1
      parameters:
        - name: deposit_id
          in: path
          required: true
          description: The deposit ID.
          schema:
            $ref: '#/components/schemas/uuid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnchainDeposit'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    uuid:
      type: string
      format: uuid
    OnchainDeposit:
      type: object
      required:
        - id
        - account_id
        - chain_id
        - safe_address
        - token
        - token_name
        - amount
        - from_address
        - tx_hash
        - block_number
        - status
        - created_at
        - updated_at
        - kyt_breakdown
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: Unique deposit identifier.
        account_id:
          $ref: '#/components/schemas/uuid'
          description: Account receiving the deposit.
        chain_id:
          type: integer
          format: int32
          description: Numeric blockchain network ID.
        safe_address:
          type: string
          description: Account funding address that received the tokens.
        token:
          type: string
          description: Token contract address.
        token_name:
          type: string
          description: Human-readable token name.
        amount:
          type: string
          description: Amount in the token's smallest unit.
        from_address:
          type: string
          description: Address that sent the tokens.
        tx_hash:
          type: string
          description: Blockchain transaction hash.
        block_number:
          type: integer
          format: int64
          description: Block number containing the transaction.
        status:
          $ref: '#/components/schemas/OnchainDepositStatus'
          description: Current deposit status.
        created_at:
          type: string
          format: date-time
          description: When the deposit was first recorded.
        updated_at:
          type: string
          format: date-time
          description: When the deposit was last updated.
        kyt_breakdown:
          anyOf:
            - $ref: '#/components/schemas/OnchainDepositKYTBreakdown'
            - type: 'null'
          description: Deposit screening result. Null while screening is still pending.
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
          description: HTTP status code.
        message:
          type: string
          description: Generic human-readable text for the status code. Do not parse it.
        reason:
          type: string
          description: >-
            Stable machine-readable code identifying the specific cause, present
            only

            for errors that expose one (e.g. `CREATE_CARD_LIMIT_EXCEEDED`).
            Branch on

            this rather than on `message`.
    OnchainDepositStatus:
      type: string
      enum:
        - pending
        - approved
        - rejected
    OnchainDepositKYTBreakdown:
      type: object
      required:
        - result
        - risk_score
        - risk_tier
      properties:
        result:
          type: string
          description: 'Outcome of the deposit screening: `approved` or `rejected`.'
        risk_score:
          anyOf:
            - type: number
              format: double
            - type: 'null'
          description: Risk score from 0 to 10, or null when no score is available.
        risk_tier:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            Risk tier: `green`, `amber`, or `red`; null when no tier is
            available.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: Bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.