com.coinbase.cdp.resources.depositdestinations
Method Details
listDepositDestinations
Overload 1
request - ListDepositDestinationsRequest
Returns:
CdpClientHttpResponse<ListDepositDestinationsResponse>
Overload 3
requestOptions - RequestOptions
Returns:
CdpClientHttpResponse<ListDepositDestinationsResponse>
Overload 4
request - ListDepositDestinationsRequest
requestOptions - RequestOptions
Returns:
CdpClientHttpResponse<ListDepositDestinationsResponse>
createDepositDestination
Overload 1
crypto (public): provisions a cryptocurrency address on the requested network. The returned crypto.address is the deposit address; funds sent to it are credited to the target account in the specified asset. For Customer-owned accounts, the Customer must have the custodyCrypto and custodyStablecoin capabilities enabled.
fiat (private-beta): provisions a bank account at a CDP banking partner. The server picks the account type (e.g. us_bank) and supported payment rails based on the account’s eligibility; pass fiat.paymentRail to influence partner selection. The returned fiat object contains the bank account details the depositor needs to send funds. For Customer-owned accounts, the Customer must have the custodyFiat capability enabled. Requires account enablement — contact your Coinbase representative for access. Fields and behavior may change before general availability.
For Customer-owned accounts not authorized for the required capabilities, the request is rejected with customer_not_authorized (HTTP 403).
The created destination’s status starts as pending for fiat (it becomes active once the partner provisioning callback completes) and active for crypto.
Parameters:
request - CreateDepositDestinationBody
Returns:
CdpClientHttpResponse<DepositDestination>
Overload 2
crypto (public): provisions a cryptocurrency address on the requested network. The returned crypto.address is the deposit address; funds sent to it are credited to the target account in the specified asset. For Customer-owned accounts, the Customer must have the custodyCrypto and custodyStablecoin capabilities enabled.
fiat (private-beta): provisions a bank account at a CDP banking partner. The server picks the account type (e.g. us_bank) and supported payment rails based on the account’s eligibility; pass fiat.paymentRail to influence partner selection. The returned fiat object contains the bank account details the depositor needs to send funds. For Customer-owned accounts, the Customer must have the custodyFiat capability enabled. Requires account enablement — contact your Coinbase representative for access. Fields and behavior may change before general availability.
For Customer-owned accounts not authorized for the required capabilities, the request is rejected with customer_not_authorized (HTTP 403).
The created destination’s status starts as pending for fiat (it becomes active once the partner provisioning callback completes) and active for crypto.
Parameters:
body - CreateDepositDestinationRequest
Returns:
CdpClientHttpResponse<DepositDestination>
Overload 3
crypto (public): provisions a cryptocurrency address on the requested network. The returned crypto.address is the deposit address; funds sent to it are credited to the target account in the specified asset. For Customer-owned accounts, the Customer must have the custodyCrypto and custodyStablecoin capabilities enabled.
fiat (private-beta): provisions a bank account at a CDP banking partner. The server picks the account type (e.g. us_bank) and supported payment rails based on the account’s eligibility; pass fiat.paymentRail to influence partner selection. The returned fiat object contains the bank account details the depositor needs to send funds. For Customer-owned accounts, the Customer must have the custodyFiat capability enabled. Requires account enablement — contact your Coinbase representative for access. Fields and behavior may change before general availability.
For Customer-owned accounts not authorized for the required capabilities, the request is rejected with customer_not_authorized (HTTP 403).
The created destination’s status starts as pending for fiat (it becomes active once the partner provisioning callback completes) and active for crypto.
Parameters:
request - CreateDepositDestinationBody
requestOptions - RequestOptions
Returns:
CdpClientHttpResponse<DepositDestination>
Overload 4
crypto (public): provisions a cryptocurrency address on the requested network. The returned crypto.address is the deposit address; funds sent to it are credited to the target account in the specified asset. For Customer-owned accounts, the Customer must have the custodyCrypto and custodyStablecoin capabilities enabled.
fiat (private-beta): provisions a bank account at a CDP banking partner. The server picks the account type (e.g. us_bank) and supported payment rails based on the account’s eligibility; pass fiat.paymentRail to influence partner selection. The returned fiat object contains the bank account details the depositor needs to send funds. For Customer-owned accounts, the Customer must have the custodyFiat capability enabled. Requires account enablement — contact your Coinbase representative for access. Fields and behavior may change before general availability.
For Customer-owned accounts not authorized for the required capabilities, the request is rejected with customer_not_authorized (HTTP 403).
The created destination’s status starts as pending for fiat (it becomes active once the partner provisioning callback completes) and active for crypto.
Parameters:
body - CreateDepositDestinationRequest
requestOptions - RequestOptions
Returns:
CdpClientHttpResponse<DepositDestination>
getDepositDestinationById
Overload 1
depositDestinationId - DepositDestinationId
Returns:
CdpClientHttpResponse<DepositDestination>
Overload 2
depositDestinationId - DepositDestinationId
request - GetDepositDestinationByIdRequest
Returns:
CdpClientHttpResponse<DepositDestination>
Overload 3
depositDestinationId - DepositDestinationId
requestOptions - RequestOptions
Returns:
CdpClientHttpResponse<DepositDestination>
Overload 4
depositDestinationId - DepositDestinationId
request - GetDepositDestinationByIdRequest
requestOptions - RequestOptions
Returns:
CdpClientHttpResponse<DepositDestination>