Skip to main content

Get Deposit by ID

Get Deposit by ID​

This endpoint retrieves detailed information about a specific deposit.

Endpoint​

  • Path: /deposit/{deposit_id}
  • Method: GET

Request​

  • Parameters:
    • deposit_id: The unique identifier of the deposit.

Response​

  • Fields:
    • id: Unique identifier for the deposit.
    • state: The current state of the deposit.
    • created_at: Date the deposit was created.
    • concluded_at: Date the deposit was concluded.
    • amount: The total amount of deposit.
    • liquid_value: The net amount received after fee.
    • payer_id: Payer's CPF/CNPJ partially visible.
    • payer_name: Name of the individual or entity who initiated the deposit.

Description​

Provides detailed information about a specific deposit, including its creation time and customer association.