---
title: "Get deposit"
method: GET
path: "/v1/deposits/{deposit_id}"
tags: ["Deposits"]
---

# Get deposit

`GET /v1/deposits/{deposit_id}`

Get a deposit's details by the deposit ID.

## Path parameters

- `deposit_id` string, required

## Parameters

- `#/paths/~1v1~1deposits/get/parameters/0` — unresolved $ref

## Response `200`

OK

- object
  - `status` Status — unresolved $ref
  - `data` object
    - `deposit_id` string — The unique deposit identifier. Prefix is "dep" in production and "sbx_dep" in sandbox.
    - `platform_id` PlatformId — unresolved $ref
    - `merchant_id` MerchantId — unresolved $ref
    - `status` Items — unresolved $ref
    - `deposit_type` Items — unresolved $ref
    - `billing_type` 'NET' | 'GROSS' — The merchant billing type.
    - `amount` integer — The amount deposited, in minor units. For example, 1000 is 10.00 USD.
    - `currency_code` 'USD' — Three-letter ISO currency code, in uppercase. Currently, only USD is supported.
    - `deposit_fee_amount` object
      - `amount` integer — The amount of the deposit fee, in minor units. For example, 20 is 0.20 USD.
      - `currency_code` CurrencyCode — unresolved $ref
    - `total_payment_billing_fees_amount` object
      - `amount` integer — The total amount of the billing fees for all the deposit activity, in minor units. For example, -100 is -1.00 USD.
      - `currency_code` CurrencyCode — unresolved $ref
    - `total_split_remainder_amount` object
      - `amount` integer — The total amount of the amount splits for all the deposit activity, in minor units. For example, -100 is -1.00 USD.
      - `currency_code` CurrencyCode — unresolved $ref
    - `total_fees_amount` object
      - `amount` integer — The total amount of the billing fees and the amount splits for all the deposit activity, in minor units. Equal to total_payment_billing_fees_amount + total_split_remainder_amount
      - `currency_code` CurrencyCode — unresolved $ref
    - `gross_amount` object
      - `amount` integer — The gross amount of all the deposit activity, in minor units. For example, 1000 is 10.00 USD.
      - `currency_code` CurrencyCode — unresolved $ref
    - `payment_totals` object — The total count and amount summaries for each payment type in the deposit. Payment types include `payins`, `refunds`, `chargebacks`, `ach_returns`, `adjustments`, and `deposits`.
      - `payins` object
        - `count` integer — The total count of the payment type deposited.
        - `gross_amount` object
          - `amount` integer — The gross amount for the payment type deposited, in minor units. For example, 1000 is 10.00 USD.
          - `currency_code` CurrencyCode — unresolved $ref
        - `billing_fees_amount` object
          - `amount` integer — The total amount of the billing fees for the payment type deposited, in minor units. For example, -20 is -0.20 USD.
          - `currency_code` CurrencyCode — unresolved $ref
        - `split_remainder_amount` object
          - `amount` integer — The total amount of the amount splits for the billing type deposited, in minor units. For example, -20 is -0.20 USD.
          - `currency_code` CurrencyCode — unresolved $ref
        - `net_amount` object
          - `amount` integer — The total amount for the payment type deposited, in minor units. Equal to gross_amount - billing_fees_amount - split_remainder_amount
          - `currency_code` CurrencyCode — unresolved $ref
      - `refunds` Payins — unresolved $ref
      - `chargebacks` Payins — unresolved $ref
      - `ach_returns` Payins — unresolved $ref
      - `adjustments` Payins — unresolved $ref
      - `deposits` Payins — unresolved $ref
    - `method_type` MethodType — unresolved $ref
    - `ach` Ach — unresolved $ref
    - `plaid_ach` PlaidAch — unresolved $ref
    - `metadata` Metadata — unresolved $ref
    - `created_at` string, date-time — Date and time deposit was created at in UTC RFC 3339 format.
  - `errors` Errors — unresolved $ref

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `403` — unresolved $ref
- `404` — Resource not found.
- `5XX` — unresolved $ref

---

[API](https://skmtc.dev/rainforestpay/apis/authentication.md) · [All operations](https://skmtc.dev/rainforestpay/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rainforestpay/authentication/revisions/529a0dab0f90/schema)