Skip to main content

Create Crypto Beneficiary

Deprecated

This endpoint is deprecated. Use POST /v3/crypto/counterparties. It keeps working for now, and its responses carry Deprecation: true and a Link header naming the v3 page; BlockWyre will tell you the date before it stops, from when it answers 410 Gone. See Crypto v3.

This endpoint allows to create a cryptocurrency beneficiary.

Technical Details​

  • Webhooks: This operation triggers the crypto_beneficiary_created webhook.
Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

POST

/api/v2/crypto/beneficiaries

Request Body Sample​

{
"accountId": "00000000-0000-0000-0000-000000000000",
"address": "0x0000000000000000000000000000000000000000",
"coin": "USDC",
"label": "John's USDC wallet",
"reference": "client-reference-123",
"network": "ERC20"
}

Request Body Schema​

FieldTypeDescription
accountIduuidRequired. The ID of the account to which the beneficiary belongs.
addressstringRequired. Address for the beneficiary, up to 255 characters. On a chain that routes by memo (XRP), write the memo inside it as <address>?dt=<tag>.
coinstringRequired. BTC, ETH, LTC, XRP, USDT or USDC, in any casing.
labelstringOptional. Label, up to 255 characters.
referencestringRequired. Your own reference for the beneficiary, up to 255 characters. It must differ from the reference of every other wallet and beneficiary in the workspace.
networkstringOptional. Network for the cryptocurrency (if applicable), up to 255 characters.

Response Sample​

{
"id": "00000000-0000-0000-0000-000000000000",
"accountId": "00000000-0000-0000-0000-000000000000",
"reference": "client-reference-123",
"coin": "USDC",
"address": "0x0000000000000000000000000000000000000000",
"label": "Treasury USDC wallet",
"network": "ERC20",
"status": "active",
"customer": {
"id": "00000000-0000-0000-0000-000000000000",
"reference": "BW0000",
"accountName": "Maria Perez",
"firstName": "Maria",
"lastName": "Perez",
"email": "maria@example.com",
"type": "individual",
"status": "active"
},
"createdAt": "2025-04-07T14:28:53.712Z",
"updatedAt": "2025-04-07T14:28:53.712Z"
}

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!