---
title: "Get account deposit method"
method: GET
path: "/core/accounts/{accountId}/deposit-method"
tags: ["Accounts"]
---

# Get account deposit method

`GET /core/accounts/{accountId}/deposit-method`

## Request

- Base URL: `https://api.enterprise.sandbox.uphold.com`
- URL: `https://api.enterprise.sandbox.uphold.com/core/accounts/{accountId}/deposit-method`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/core/oauth2/token` scopes: `core.accounts:deposit-method`
- TypeScript: <https://skmtc.dev/uphold/apis/core-api/docs/core/accounts/:accountId/deposit-method/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets deposit method for depositing into an account externally.

## Path parameters

- `accountId` string, uuid, required

## Query parameters

- `type` 'crypto' | 'bank', required
- `asset` string, required
- `network` string, required

## Headers

- `X-On-Behalf-Of` string
- `X-Uphold-User-Ip` union
  - string, ipv4
  - string, ipv6
- `X-Uphold-User-Agent` string
- `X-Uphold-User-Origin` string
- `X-Uphold-User-Country` string
- `X-Uphold-User-Subdivision` string
- `X-Uphold-User-City` string

## Response `200`

Deposit method retrieved.

- object
  - `depositMethod` AccountDepositMethod, required
    - `type` 'crypto' | 'bank', required: The deposit method type.
    - `status` 'processing' | 'ok' | 'failed', required: The status of the deposit method.
    - `details` union: The details of the deposit method based on the type and network.
      - AccountDepositMethodDetailsCrypto
        - `network` string, required: The network to use for the crypto transaction.
        - `asset` string, required: The asset to use for the crypto transaction.
        - `address` string, required: The destination address to use for the crypto transaction.
        - `addressFormats` object[], required: The different address formats available for the crypto transaction.
          - `format` 'native-segwit' | 'wrapped-segwit' | 'pubkey-hash', required: The format type of the address.
          - `value` string, required: The address value in the specified format.
        - `reference` string: The additional identifier to include with the transaction, usually added in the memo or tag fields depending on the network.
      - AccountDepositMethodDetailsBankFps
        - `network` 'fps', required: The bank network to use for the bank transfer.
        - `asset` string, required: The asset to use for the bank transfer.
        - `beneficiary` string, required: The bank transfer's beneficiary name.
        - `bankName` string, required: The bank name the account belongs to.
        - `bankAddress` object, required: The bank address the account belongs to.
          - `line1` string, required: The first line of the bank address.
          - `line2` string: The second line of the bank address.
        - `sortCode` string, required: The sort code to use for the FPS transfer.
        - `accountNumber` string, required: The account number to use for the FPS transfer.
        - `reference` string: The additional identifier to include with the FPS transfer description.
      - AccountDepositMethodDetailsBankSepa
        - `network` 'sepa', required: The bank network to use for the bank transfer.
        - `asset` string, required: The asset to use for the bank transfer.
        - `beneficiary` string, required: The bank transfer's beneficiary name.
        - `bankName` string, required: The bank name the account belongs to.
        - `bankAddress` object, required: The bank address the account belongs to.
          - `line1` string, required: The first line of the bank address.
          - `line2` string: The second line of the bank address.
        - `bic` string, required: The bank's BIC for the SEPA transfer.
        - `iban` string, required: The destination IBAN for the SEPA transfer.
        - `reference` string, required: The reference code to include in the SEPA transfer description field.
      - AccountDepositMethodDetailsBankUsRails
        - `network` 'ach' | 'fednow' | 'rtp' | 'wire', required: The bank network to use for the bank transfer.
        - `asset` string, required: The asset to use for the bank transfer.
        - `beneficiary` string, required: The bank transfer's beneficiary name.
        - `bankName` string, required: The bank name the account belongs to.
        - `bankAddress` object, required: The bank address the account belongs to.
          - `line1` string, required: The first line of the bank address.
          - `line2` string: The second line of the bank address.
        - `routingNumber` string, required: The routing number to use for the bank transfer.
        - `accountNumber` string, required: The account number to use for the bank transfer.
        - `accountType` 'checking', required: The account type to use for the bank transfer.
        - `secondaryNetworks` string[]: The secondary networks that the bank account can be used with.

## Other responses

- `400`: Bad Request.
- `401`: Unauthorized.
- `403`: Forbidden.
- `404`: Resource not found.
- `409`: Business logic error.
- `429`: Too Many Requests.

---

[API](https://skmtc.dev/uphold/apis/core-api.md) - [All operations](https://skmtc.dev/uphold/apis/core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uphold/apis/core-api/revisions/6c663575c57a?raw)