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

# Get deposit status

> Check the status of any deposit by ID, regardless of the payment method. Returns current status, bank account details, and transaction information. For NGN payins, includes the virtual account details in metadata.



## OpenAPI

````yaml /openapi.json get /v1/deposits/{id}
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Comprehensive payment platform API supporting fiat and crypto payments,
    currency conversion, and compliance management
  title: Zuba Payment Platform API
  version: '1.0'
servers: []
security: []
tags:
  - description: Manage M2M API keys and credentials
    name: API Keys
  - description: Internal ledger accounts and transactions
    name: Ledger
  - description: Handle incoming payments and deposits
    name: Pay-ins
  - description: Manage payouts, beneficiaries, and SEPA transfers
    name: Payouts
  - description: Manage outbound webhook endpoints and deliveries
    name: Webhooks
paths:
  /v1/deposits/{id}:
    get:
      tags:
        - Pay-ins
      summary: Get deposit status
      description: >-
        Check the status of any deposit by ID, regardless of the payment method.
        Returns current status, bank account details, and transaction
        information. For NGN payins, includes the virtual account details in
        metadata.
      operationId: PayinController_getDepositStatus
      parameters:
        - description: Unique deposit identifier (UUID format)
          in: path
          name: id
          required: true
          schema:
            example: 123e4567-e89b-12d3-a456-426614174000
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                ngnPayin:
                  summary: NGN payin status
                  value:
                    createdAt: '2024-01-15T10:30:00Z'
                    id: f47ac10b-58cc-4372-a567-0e02b2c3d479
                    status: pending
                    updatedAt: '2024-01-15T10:30:00Z'
              schema:
                $ref: '#/components/schemas/PayinStatusDto'
          description: Deposit status retrieved successfully
        '401':
          description: Unauthorized - missing or invalid JWT token
        '404':
          description: Deposit not found or does not belong to user
        '500':
          description: Internal Server Error
      security:
        - bearer: []
components:
  schemas:
    PayinStatusDto:
      properties:
        createdAt:
          description: Creation timestamp
          example: '2024-01-15T10:30:00Z'
          format: date-time
          type: string
        errorMessage:
          description: Error message if the pay-in failed
          example: Payment declined by bank
          type: string
        id:
          description: Unique identifier for the pay-in
          example: 123e4567-e89b-12d3-a456-426614174000
          format: uuid
          type: string
        providerTransactionId:
          description: Transaction ID from the payment provider
          example: TXN-123456789
          type: string
        status:
          description: Current status of the pay-in
          enum:
            - pending
            - processing
            - completed
            - failed
            - cancelled
            - refunding
            - refunded
            - in_review
          example: completed
          type: string
        updatedAt:
          description: Last update timestamp
          example: '2024-01-15T10:35:00Z'
          format: date-time
          type: string
      required:
        - id
        - status
        - createdAt
        - updatedAt
      type: object
  securitySchemes:
    bearer:
      bearerFormat: JWT
      description: Enter Auth0 JWT token
      scheme: bearer
      type: http

````