Wallets
On-chain USDT destinations.
Wallets receive USDT withdrawals. The POST /crypto-beneficiaries body uses camelCase (walletType, travelAddress). Chains: tron, eth or polygon. The only asset is USDT.
Create a wallet
/api/v1/crypto-beneficiaries
Register a USDT destination. Scope payouts:write.
Parameters
AuthorizationstringRequiredBearer $CLOBEPAY_API_KEY. X-API-Key with the same value is also accepted. Do not send both.
namestringRequiredWallet holder name.
chainstringRequiredAddress chain.
tron · eth · polygon
assetstringRequiredUSDT only.
addressstringRequiredDestination address (TRON base58check or 0x… EVM).
walletTypestringOptionalDefaults to self_hosted.
self_hosted · institution
travelAddressstringOptionalTravel Rule: ta… code, only if walletType is institution.
Responses
- HTTP 201Wallet created. The address is stored encrypted: the response does not include it, only addressLast6 and addressMasked.
Errors
- HTTP 400
ambiguous_credentialsAuthorization: Bearer and X-API-Key carry different keys. - HTTP 401
missing_credentialsNo key was sent (Authorization: Bearer or X-API-Key). - HTTP 401
invalid_api_keyThe key does not exist, is malformed or does not match. - HTTP 401
api_key_revokedThe key was revoked. - HTTP 401
api_key_expiredThe key expired. - HTTP 401
api_key_wrong_environmentThe key belongs to another environment (test key in live, or the other way around). - HTTP 403
insufficient_scopeThe key does not have the scope for this route. - HTTP 429
rate_limitedToo many requests. Honour Retry-After. - HTTP 422
invalid_addressInvalid address or chain.
curl -X POST "$CLOBEPAY_API_BASE/crypto-beneficiaries" \ -H "Authorization: Bearer $CLOBEPAY_API_KEY" \ -H "Content-Type: application/json" \ -d '{"name":"Atlas Creativo LLC","chain":"tron","asset":"USDT","address":"TNPeeaaFB7K9cmo4uQpcU32zGK8G1NYqeL","walletType":"self_hosted"}'Response
HTTP 201{
"id": "a41c82e7-3b6d-4c90-9e2a-5f17d0b8c4e3",
"name": "Atlas Creativo LLC",
"chain": "tron",
"asset": "USDT",
"addressLast6": "1NYqeL",
"addressMasked": "…1NYqeL",
"walletType": "self_hosted"
}List wallets
/api/v1/crypto-beneficiaries
Wallets of your merchant. Scope payouts:read.
Parameters
AuthorizationstringRequiredBearer $CLOBEPAY_API_KEY. X-API-Key with the same value is also accepted. Do not send both.
Responses
- HTTP 200List.
Errors
- HTTP 400
ambiguous_credentialsAuthorization: Bearer and X-API-Key carry different keys. - HTTP 401
missing_credentialsNo key was sent (Authorization: Bearer or X-API-Key). - HTTP 401
invalid_api_keyThe key does not exist, is malformed or does not match. - HTTP 401
api_key_revokedThe key was revoked. - HTTP 401
api_key_expiredThe key expired. - HTTP 401
api_key_wrong_environmentThe key belongs to another environment (test key in live, or the other way around). - HTTP 403
insufficient_scopeThe key does not have the scope for this route. - HTTP 429
rate_limitedToo many requests. Honour Retry-After.
curl -X GET "$CLOBEPAY_API_BASE/crypto-beneficiaries" \ -H "Authorization: Bearer $CLOBEPAY_API_KEY"Response
HTTP 200{
"items": []
}Retrieve a wallet
/api/v1/crypto-beneficiaries/{walletId}
Detail by UUID. Scope payouts:read.
Parameters
AuthorizationstringRequiredBearer $CLOBEPAY_API_KEY. X-API-Key with the same value is also accepted. Do not send both.
walletIduuidRequiredWallet UUID.
Responses
- HTTP 200Detail (addressLast6 and addressMasked, without the full address).
Errors
- HTTP 400
ambiguous_credentialsAuthorization: Bearer and X-API-Key carry different keys. - HTTP 401
missing_credentialsNo key was sent (Authorization: Bearer or X-API-Key). - HTTP 401
invalid_api_keyThe key does not exist, is malformed or does not match. - HTTP 401
api_key_revokedThe key was revoked. - HTTP 401
api_key_expiredThe key expired. - HTTP 401
api_key_wrong_environmentThe key belongs to another environment (test key in live, or the other way around). - HTTP 403
insufficient_scopeThe key does not have the scope for this route. - HTTP 429
rate_limitedToo many requests. Honour Retry-After. - HTTP 404
not_foundIt does not exist or is not yours. Also if walletId is not a UUID.
curl -X GET "$CLOBEPAY_API_BASE/crypto-beneficiaries/a41c82e7-3b6d-4c90-9e2a-5f17d0b8c4e3" \ -H "Authorization: Bearer $CLOBEPAY_API_KEY"Response
HTTP 200Detail (addressLast6 and addressMasked, without the full address).