Withdraw to counterparty Id

POST /api/v1/transfers/withdraw/counterparty

Withdraw to counterparty Id

cURL

curl --request POST \
  --url https://api.international.coinbase.com/api/v1/transfers/withdraw/counterparty \
  --header 'CB-ACCESS-KEY: <api-key>' \
  --header 'CB-ACCESS-PASSPHRASE: <api-key>' \
  --header 'CB-ACCESS-SIGN: <api-key>' \
  --header 'CB-ACCESS-TIMESTAMP: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "portfolio": "<string>",
  "counterparty_id": "CBTQDGENHE",
  "asset": "<string>",
  "amount": "<string>",
  "nonce": 30
}
'

200

{
  "idem": "253b30a5-9b03-4cd2-9c76-d0f32b2bd733",
  "portfolio_uuid": "3d50e347-6a59-4965-a4cd-b25934d84126",
  "source_counterparty_id": "CBTQDGENHE",
  "target_counterparty_id": "CBA6POFJW7",
  "asset": "USDC",
  "amount": 5100.5
}

Java

TransfersService transfersService = IntxServiceFactory.createTransfersService(client);
WithdrawToCounterpartyIdRequest request = new WithdrawToCounterpartyIdRequest.Builder()
    .portfolio("portfolio_id")
    .counterpartyId("counterparty_id")
    .asset("BTC")
    .amount("1")
    .build();
WithdrawToCounterpartyIdResponse response = transfersService.withdrawToCounterpartyId(request);

For more information, please visit the INTX Java SDK.

.NET

var transfersService = new TransfersService(client);
var request = new WithdrawToCounterpartyIdRequest(
    Portfolio: "portfolio_id",
    CounterpartyId: "counterparty_id",
    Asset: "BTC",
    Amount: "1",
);
var response = transfersService.WithdrawToCounterpartyId(request);

For more information, please visit the INTX .NET SDK.

Go

transfersSvc := transfers.NewTransfersService(client)
request := &transfers.CreateWithdrawalToCounterpartyIdRequest{
    Portfolio: "portfolio_id",
    CounterpartyId: "counterparty_id",
    Asset: "BTC",
    Amount: "1",
}
response, err := transfersSvc.CreateWithdrawalToCounterpartyId(context.Background(), request)

For more information, please visit the INTX Go SDK.

Python

client = IntxClient()
request = WithdrawToCounterpartyIdRequest(
    portfolio="portfolio_id",
    counterparty_id="counterparty_id",
    asset="BTC",
    amount="1",
)
response = client.withdraw_to_counterparty_id(request)

For more information, please visit the INTX Python SDK.

TS/JS

const transfersService = new TransfersService(client);

transfersService.withdrawToCounterparty({
    portfolio: 'PORTFOLIO_ID_HERE',
    counterpartyId: 'COUNTERPARTY_ID_HERE',
    asset: 'BTC',
    amount: "1",
    nonce: 12345
}).then(async (response) => {
    console.log('Withdrawal created: ', response);
})

For more information, please visit the INTX TS SDK.

CLI

intxctl create-withdrawal-to-counterparty-id --help

For more information, please visit the INTX CLI.

Authorizations

CB-ACCESS-KEY · string · header · required

The Client ID that owns the API Key for the request

CB-ACCESS-PASSPHRASE · string · header · required

The pass phrase affiliated with the API Key

CB-ACCESS-SIGN · string · header · required

A HMAC SHA-256 signature using the API Key secret on the string TIMESTAMP, METHOD, REQUEST_PATH, BODY

CB-ACCESS-TIMESTAMP · string · header · required

The timestamp of when the request is being made

Body

application/json

portfolio · string · required

Identifies the portfolio to withdraw from by UUID (e.g., 892e8c7c-e979-4cad-b61b-55a197932cf1) or portfolio ID (e.g., 5189861793641175)

counterparty_id · string · required

Counterparty Id to withdraw to

Example:

"CBTQDGENHE"

asset · string · required

Identifies the asset by name (e.g., BTC), UUID (e.g., 291efb0f-2396-4d41-ad03-db3b2311cb2c), or asset ID (e.g., 1482439423963469)

amount · string · required

The amount of the asset being transferred

nonce · integer · required

A unique positive integer representing the withdrawal request

Example:

30

Response

200

application/json

Counterparty withdrawal initiated

idem · string

Idempotent UUID representing the successful withdraw

Example:

"253b30a5-9b03-4cd2-9c76-d0f32b2bd733"

portfolio_uuid · string<uuid>

UUID for the portfolio where the withdraw was initiated

Example:

"3d50e347-6a59-4965-a4cd-b25934d84126"

source_counterparty_id · string

Counterparty Id of the source portfolio

Example:

"CBTQDGENHE"

target_counterparty_id · string

Counterparty Id of the target portfolio

Example:

"CBA6POFJW7"

asset · string

The asset being transferred

Example:

"USDC"

amount · string

The amount of the asset being transferred

Example:

5100.5