> ## Documentation Index
> Fetch the complete documentation index at: https://developer.uphold.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get account deposit method
> Gets deposit method for depositing into an account externally.
export const RestEndpointSubjects = ({subjects = []}) => {
const subjectToIconMap = {
'client': 'browser',
'user:individual': 'user',
'user:business': 'briefcase'
};
if (subjects.length === 0) {
return null;
}
return <>
{subjects.map(subject =>
{subject}
)}
;
};
Use this endpoint to retrieve the deposit method for a given account, asset, and network. This is useful for determining available deposit options before initiating a deposit setup.
You can check which assets support deposits by calling the [List Assets](../assets/list-assets) endpoint and filtering for assets that have `deposit` included in their features.
Once you select an asset, you can determine the supported networks by calling the [List Rails](../assets/list-rails) endpoint for that asset and filtering for rails that also include `deposit` in their features.
For more details, refer to the **[Assets section](../assets/introduction)**.
Calling this endpoint will not trigger the [asynchronous setup process](./set-up-account-deposit-method#asynchronous-setup-process) of the deposit method which some networks require. You will need to call the [Set up Account Deposit Method](./set-up-account-deposit-method) endpoint to trigger it.
## OpenAPI
````yaml _media/specs/core-openapi.mintlify.json get /core/accounts/{accountId}/deposit-method
openapi: 3.1.0
info:
version: 0.1.0
title: Core API
description: >-
The Core API provides essential building blocks that empower businesses to
embed financial services into their applications.
contact:
name: Uphold API Team
email: developers@uphold.com
url: https://developer.uphold.com
servers:
- url: https://api.enterprise.sandbox.uphold.com
description: Sandbox
- url: https://api.enterprise.uphold.com
description: Production
security:
- OAuth2: []
tags:
- name: Authentication
description: Authentication.
- name: Countries
description: Countries.
- name: Users
description: Users.
- name: KYC
description: Individual User's KYC.
- name: KYB
description: Business User's KYB.
- name: Capabilities
description: User capabilities.
- name: Terms of service
description: User terms of service.
- name: Files
description: Files.
- name: Assets
description: Assets, networks and rails.
- name: Accounts
description: Accounts.
- name: External accounts
description: External accounts.
- name: Transactions
description: Transactions.
- name: Portfolio
description: Portfolio.
- name: Statements
description: Statements.
- name: Metadata
description: Metadata.
- name: Webhooks
description: Webhooks.
paths:
/core/accounts/{accountId}/deposit-method:
get:
tags:
- Accounts
summary: Get account deposit method
description: Gets deposit method for depositing into an account externally.
operationId: core.get-account-deposit-method
parameters:
- $ref: '#/components/parameters/account-id'
- $ref: '#/components/parameters/account-deposit-method-type'
- $ref: '#/components/parameters/account-deposit-method-asset'
- $ref: '#/components/parameters/account-deposit-method-network'
responses:
'200':
$ref: '#/components/responses/get-account-deposit-method-response'
'404':
$ref: >-
#/components/responses/get-account-deposit-method-account-not-found-response
'409':
$ref: '#/components/responses/get-account-deposit-method-conflict-response'
security:
- OAuth2:
- core.accounts:deposit-method
components:
parameters:
account-id:
name: accountId
description: The account id.
in: path
required: true
schema:
type: string
format: uuid
examples:
Account Identifier:
value: 555a99a1-620d-4431-a0ac-b43e1aad2bdc
account-deposit-method-type:
name: type
in: query
description: The type of the deposit method.
required: true
schema:
$ref: '#/components/schemas/account-deposit-method-type'
account-deposit-method-asset:
name: asset
in: query
description: The asset to use for the deposit.
required: true
schema:
type: string
account-deposit-method-network:
name: network
in: query
description: The network to use for the deposit.
required: true
schema:
type: string
responses:
get-account-deposit-method-response:
description: Deposit method retrieved.
content:
application/json:
schema:
type: object
properties:
depositMethod:
$ref: '#/components/schemas/account-deposit-method'
required:
- depositMethod
examples:
Bitcoin Crypto Deposit Method:
value:
depositMethod:
type: crypto
status: ok
details:
asset: BTC
network: bitcoin
address: tb1qktapuxvq6u39n7tc4sfkp9q8vwecrqza7xeqhn
addressFormats:
- format: native-segwit
value: tb1qktapuxvq6u39n7tc4sfkp9q8vwecrqza7xeqhn
- format: wrapped-segwit
value: 2MzJXEZeyJV4jMHxkeGY7x88DPpF15p78ks
Stellar Crypto Deposit Method:
value:
depositMethod:
type: crypto
status: ok
details:
asset: XLM
network: stellar
address: GC3ZSJ3K2HKSN7MKK2SXNFBELR5Y5WE5HMVDO7UG6SQE55DEJY55BYWK
addressFormats:
- format: pubkey-hash
value: >-
GC3ZSJ3K2HKSN7MKK2SXNFBELR5Y5WE5HMVDO7UG6SQE55DEJY55BYWK
reference: '0123456789'
FPS Bank Deposit Method:
value:
depositMethod:
type: bank
status: ok
details:
network: fps
asset: GBP
beneficiary: John Doe
bankName: Example Bank
bankAddress:
line1: 123 Bank Street
line2: London, United Kingdom
sortCode: '123456'
accountNumber: '12345678'
reference: UH12345678
SEPA Bank Deposit Method:
value:
depositMethod:
type: bank
status: ok
details:
network: sepa
asset: EUR
beneficiary: John Doe
bankName: Example Bank
bankAddress:
line1: 123 Bank Street
line2: Vienna, Austria
bic: EXAAAT2K
iban: AT487954841229809844
reference: UH12345678
ACH Bank Deposit Method:
value:
depositMethod:
type: bank
status: ok
details:
network: ach
asset: USD
beneficiary: John Doe
bankName: Cross River Bank
bankAddress:
line1: 2 Riverview Dr
line2: Fort Lee, NJ 07024
routingNumber: '021214891'
accountNumber: '377876871270'
accountType: checking
secondaryNetworks:
- fednow
- wire
FedNow/RTP Bank Deposit Method:
value:
depositMethod:
type: bank
status: ok
details:
network: fednow
asset: USD
beneficiary: John Doe
bankName: Cross River Bank
bankAddress:
line1: 2 Riverview Dr
line2: Fort Lee, NJ 07024
routingNumber: '021214891'
accountNumber: '377876871270'
accountType: checking
secondaryNetworks:
- ach
- wire
Wire Bank Deposit Method:
value:
depositMethod:
type: bank
status: ok
details:
network: wire
asset: USD
beneficiary: John Doe
bankName: Cross River Bank
bankAddress:
line1: 2 Riverview Dr
line2: Fort Lee, NJ 07024
routingNumber: '021214891'
accountNumber: '377876871270'
accountType: checking
secondaryNetworks:
- ach
- fednow
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
get-account-deposit-method-account-not-found-response:
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Account Not Found:
value:
code: entity_not_found
message: The account cannot be found
details:
entity: account
Rail Not Found:
value:
code: entity_not_found
message: >-
A rail for the specified type, asset and network cannot be
found
details:
entity: rail
Deposit Method Not Found:
value:
code: entity_not_found
message: >-
A deposit method for the specified type, asset and network
cannot be found
details:
entity: depositMethod
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
get-account-deposit-method-conflict-response:
description: Business logic error.
content:
application/json:
schema:
$ref: '#/components/schemas/error'
examples:
Rail Missing Deposit Feature:
value:
code: rail_feature_not_available
message: The 'deposit' feature is not available for the rail
details:
feature: deposit
Account Asset Missing Buy Feature:
value:
code: asset_feature_not_available
message: The 'buy' feature is not available for the account asset
details:
context: path
property: accountId
feature: buy
Account Asset Missing Transfer Feature:
value:
code: asset_feature_not_available
message: The 'transfer' feature is not available for the account asset
details:
context: path
property: accountId
feature: transfer
Deposits Available Only To Default Account:
value:
code: rail_constraint_violated
message: >-
Deposits for this rail are only available to the default
account
details:
rule: allowed-deposit-accounts
User Capability Failure:
value:
code: user_capability_failure
message: The user has capability constraints
details:
capability:
code: deposits
requirements: []
restrictions:
- user-status-not-valid
headers:
x-uphold-request-id:
description: >-
A unique identifier for the request that can be shared with Uphold
for troubleshooting purposes.
required: true
schema:
type: string
format: uuid
examples:
Request ID:
value: 9092ee4d-f0fb-42e9-8787-b668dbcec531
schemas:
account-deposit-method-type:
type: string
enum:
- crypto
- bank
account-deposit-method:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/account-deposit-method-type'
- description: The deposit method type.
status:
description: The status of the deposit method.
type: string
enum:
- processing
- ok
- failed
details:
description: The details of the deposit method based on the type and network.
oneOf:
- $ref: '#/components/schemas/account-deposit-method-details-crypto'
title: Crypto
- $ref: '#/components/schemas/account-deposit-method-details-bank-fps'
title: Bank (FPS)
- $ref: '#/components/schemas/account-deposit-method-details-bank-sepa'
title: Bank (SEPA)
- $ref: >-
#/components/schemas/account-deposit-method-details-bank-us-rails
title: Bank (US Rails)
required:
- type
- status
error:
description: The error information.
allOf:
- $ref: '#/components/schemas/feedback'
account-deposit-method-details-crypto:
type: object
properties:
network:
description: The network to use for the crypto transaction.
type: string
asset:
description: The asset to use for the crypto transaction.
type: string
address:
description: The destination address to use for the crypto transaction.
type: string
addressFormats:
description: The different address formats available for the crypto transaction.
type: array
items:
type: object
properties:
format:
allOf:
- $ref: >-
#/components/schemas/account-deposit-method-detail-crypto-format
- description: The format type of the address.
value:
description: The address value in the specified format.
type: string
required:
- format
- value
minItems: 1
reference:
description: >-
The additional identifier to include with the transaction, usually
added in the memo or tag fields depending on the network.
type: string
required:
- address
- addressFormats
- asset
- network
account-deposit-method-details-bank-fps:
allOf:
- $ref: '#/components/schemas/account-deposit-method-details-bank-base'
- type: object
properties:
network:
enum:
- fps
sortCode:
description: The sort code to use for the FPS transfer.
type: string
accountNumber:
description: The account number to use for the FPS transfer.
type: string
reference:
description: >-
The additional identifier to include with the FPS transfer
description.
type: string
required:
- accountNumber
- sortCode
account-deposit-method-details-bank-sepa:
allOf:
- $ref: '#/components/schemas/account-deposit-method-details-bank-base'
- type: object
properties:
network:
enum:
- sepa
bic:
description: The bank's BIC for the SEPA transfer.
type: string
iban:
description: The destination IBAN for the SEPA transfer.
type: string
reference:
description: >-
The reference code to include in the SEPA transfer description
field.
type: string
required:
- bic
- iban
- reference
account-deposit-method-details-bank-us-rails:
allOf:
- $ref: '#/components/schemas/account-deposit-method-details-bank-base'
- type: object
properties:
network:
enum:
- ach
- fednow
- rtp
- wire
routingNumber:
description: The routing number to use for the bank transfer.
type: string
accountNumber:
description: The account number to use for the bank transfer.
type: string
accountType:
description: The account type to use for the bank transfer.
type: string
enum:
- checking
secondaryNetworks:
description: The secondary networks that the bank account can be used with.
type: array
items:
type: string
enum:
- ach
- fednow
- rtp
- wire
required:
- routingNumber
- accountNumber
- accountType
feedback:
description: A feedback message with a code and human-readable description.
type: object
properties:
code:
description: A short string with a brief explanation about the code reported.
type: string
message:
description: A human-readable message providing more details.
type: string
details:
description: Additional information about the feedback reported.
type: object
additionalProperties: true
required:
- code
- message
account-deposit-method-detail-crypto-format:
type: string
enum:
- native-segwit
- wrapped-segwit
- pubkey-hash
account-deposit-method-details-bank-base:
type: object
properties:
network:
description: The bank network to use for the bank transfer.
type: string
asset:
description: The asset to use for the bank transfer.
type: string
beneficiary:
description: The bank transfer's beneficiary name.
type: string
bankName:
description: The bank name the account belongs to.
type: string
bankAddress:
description: The bank address the account belongs to.
type: object
properties:
line1:
description: The first line of the bank address.
type: string
line2:
description: The second line of the bank address.
type: string
required:
- line1
required:
- asset
- network
- beneficiary
- bankName
- bankAddress
securitySchemes:
OAuth2:
type: oauth2
description: OAuth 2.0 authentication.
flows:
clientCredentials:
tokenUrl: /core/oauth2/token
scopes:
core.users:act-on-behalf-of: Grants access to act on behalf of a user
core.users:create: Grants access to create users
core.users:read: Grants access to view users
core.users:delete: Grants access to delete users
core.users.metadata:read: Grants access to view user metadata
core.users.metadata:write: Grants access to modify user metadata
core.kyc:read: Grants access to view KYC processes
core.kyc.profile:update: Grants access to update profile KYC process
core.kyc.address:update: Grants access to update address KYC process
core.kyc.email:update: Grants access to update email KYC process
core.kyc.phone:update: Grants access to update phone KYC process
core.kyc.identity:update: Grants access to update identity KYC process
core.kyc.proof-of-address:update: Grants access to update proof-of-address KYC process
core.kyc.customer-due-diligence:update: Grants access to update customer due diligence KYC process
core.kyc.enhanced-due-diligence:update: Grants access to update enhanced due diligence KYC process
core.kyc.crypto-risk-assessment:update: Grants access to update crypto risk assessment KYC process
core.kyc.self-categorization-statement:update: Grants access to update self-categorization statement KYC process
core.kyc.tax-details:update: Grants access to update tax details KYC process
core.capabilities:read: Grants access to view user capabilities
core.terms-of-service:read: Grants access to view terms of service
core.terms-of-service:accept: Grants access to accept terms of service
core.files:create: Grants access to create files
core.files:read: Grants access to view files
core.files.metadata:read: Grants access to view files metadata
core.files.metadata:write: Grants access to modify files metadata
core.accounts:create: Grants access to create accounts
core.accounts:read: Grants access to view accounts
core.accounts:update: Grants access to update accounts
core.accounts:archive: Grants access to archive accounts
core.accounts:deposit-method: >-
Grants access to deposit method needed for depositing into
accounts
core.accounts:use-test-helpers: Grants access to test helpers of accounts
core.accounts.metadata:read: Grants access to view accounts metadata
core.accounts.metadata:write: Grants access to modify accounts metadata
core.assets:use-test-helpers: Grants access to test helpers of assets
core.external-accounts:create: Grants access to create external accounts
core.external-accounts:read: Grants access to view external accounts
core.external-accounts:update: Grants access to update external accounts
core.external-accounts:delete: Grants access to delete external accounts
core.external-accounts.metadata:read: Grants access to view external accounts metadata
core.external-accounts.metadata:write: Grants access to modify external accounts metadata
core.transactions:create: Grants access to commit quotes
core.transactions:read: Grants access to view transactions
core.transactions.metadata:read: Grants access to view transactions metadata
core.transactions.metadata:write: Grants access to modify transactions metadata
core.transactions.requests-for-information:read: Grants access to view transactions requests for information
core.transactions.requests-for-information:update: Grants access to update transactions requests for information
core.portfolio:read: >-
Grants access to view portfolio overview, performance, and
historical balance
core.statements:read: Grants access to read statements
core.webhooks:management-link: Grants access to create webhook management links
````