Skip to main content
Package: com.coinbase.cdp.resources.transfers.requests

Method Details

getIdempotencyKey

Returns: Optional<String> - An optional string request header for making requests safely retryable. When included, duplicate requests with the same key will return identical responses. Refer to our Idempotency docs for more information on using idempotency keys.

getSource

Returns: CreateTransferSource

getTarget

Returns: TransferTarget

getAmount

Returns: PositiveDecimal - The amount of the transfer, as a decimal string in standard unit denomination of the asset specified by asset (e.g., “100.00” for 100 USD, “0.05” for 0.05 ETH).

getAsset

Returns: Asset - The symbol of the asset for the amount. This must be one of the assets of the source or target.

getAmountType

Returns: Optional<TransferRequestAmountType> - Specifies whether the given amount is to be received by the target or taken from the source. target: The transfer target receives the exact value specified in amount. Fees are added to the amount taken from the transfer source. source: The transfer target receives the value specified in amount, minus any fees.

getValidateOnly

Returns: Optional<Boolean> - If true, validates the transfer without initiating it. If the request is valid, a 2xx will be returned. If the request is invalid, a 4xx error will be returned. The response will include an errorType, for e.g. invalid_target if the specified target cannot receive funds.

getExecute

Returns: boolean - Whether to immediately execute the transfer. If false, the transfer will be created in quoted status and must be executed manually via the /execute endpoint.

getMetadata

Returns: Optional<Metadata>

getTravelRule

Returns: Optional<TravelRule> - Travel Rule compliance information for this transfer. Required for transfers to external wallets above regulatory thresholds. Fields required differ by region and Coinbase contracting entity.

equals

Overrides: [equals](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals\(java.lang.Object\) "class or interface in java.lang") in class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Parameters: other - Object Returns: boolean

getAdditionalProperties

Returns: Map<String,Object>

hashCode

Overrides: [hashCode](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode\(\) "class or interface in java.lang") in class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Returns: int

toString

Overrides: [toString](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString\(\) "class or interface in java.lang") in class [Object](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html "class or interface in java.lang") Returns: String

builder

Returns: TransferRequest.SourceStage