Volver a la referencia

Billeteras

Destinos USDT on-chain.

Las billeteras reciben retiros en USDT. El cuerpo de POST /crypto-beneficiaries usa camelCase (walletType, travelAddress). Cadenas: tron, eth o polygon. El activo es solo USDT.

POST

Crear una billetera

/api/v1/crypto-beneficiaries

Alta de un destino USDT. Scope payouts:write.

Parámetros

Authorization
header
stringObligatorio

Bearer $CLOBEPAY_API_KEY. También se acepta X-API-Key con el mismo valor. No envíes ambos.

name
body
stringObligatorio

Titular de la billetera.

chain
body
stringObligatorio

Red de la dirección.

tron · eth · polygon

asset
body
stringObligatorio

Solo USDT.

address
body
stringObligatorio

Dirección destino (TRON base58check o 0x… EVM).

walletType
body
stringOpcional

Por defecto self_hosted.

self_hosted · institution

travelAddress
body
stringOpcional

Travel Rule: código ta…, solo si walletType es institution.

Respuestas

  • HTTP 201Billetera creada. La dirección se guarda cifrada: la respuesta no la incluye, solo addressLast6 y addressMasked.

Errores

  • HTTP 400ambiguous_credentialsAuthorization: Bearer y X-API-Key traen llaves distintas.
  • HTTP 401missing_credentialsNo enviaste la llave (Authorization: Bearer o X-API-Key).
  • HTTP 401invalid_api_keyLa llave no existe, está mal formada o no coincide.
  • HTTP 401api_key_revokedLa llave fue revocada.
  • HTTP 401api_key_expiredLa llave expiró.
  • HTTP 401api_key_wrong_environmentLa llave es de otro ambiente (llave de prueba en producción o al revés).
  • HTTP 403insufficient_scopeLa llave no tiene el scope de esta ruta.
  • HTTP 429rate_limitedDemasiadas peticiones. Respeta Retry-After.
  • HTTP 422invalid_addressDirección o cadena inválida.
POST/crypto-beneficiaries
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"}'

Respuesta

HTTP 201
{
  "id": "a41c82e7-3b6d-4c90-9e2a-5f17d0b8c4e3",
  "name": "Atlas Creativo LLC",
  "chain": "tron",
  "asset": "USDT",
  "addressLast6": "1NYqeL",
  "addressMasked": "…1NYqeL",
  "walletType": "self_hosted"
}

GET

Listar billeteras

/api/v1/crypto-beneficiaries

Billeteras de tu comercio. Scope payouts:read.

Parámetros

Authorization
header
stringObligatorio

Bearer $CLOBEPAY_API_KEY. También se acepta X-API-Key con el mismo valor. No envíes ambos.

Respuestas

  • HTTP 200Listado.

Errores

  • HTTP 400ambiguous_credentialsAuthorization: Bearer y X-API-Key traen llaves distintas.
  • HTTP 401missing_credentialsNo enviaste la llave (Authorization: Bearer o X-API-Key).
  • HTTP 401invalid_api_keyLa llave no existe, está mal formada o no coincide.
  • HTTP 401api_key_revokedLa llave fue revocada.
  • HTTP 401api_key_expiredLa llave expiró.
  • HTTP 401api_key_wrong_environmentLa llave es de otro ambiente (llave de prueba en producción o al revés).
  • HTTP 403insufficient_scopeLa llave no tiene el scope de esta ruta.
  • HTTP 429rate_limitedDemasiadas peticiones. Respeta Retry-After.
GET/crypto-beneficiaries
curl -X GET "$CLOBEPAY_API_BASE/crypto-beneficiaries" \  -H "Authorization: Bearer $CLOBEPAY_API_KEY"

Respuesta

HTTP 200
{
  "items": []
}

GET

Consultar una billetera

/api/v1/crypto-beneficiaries/{walletId}

Detalle por UUID. Scope payouts:read.

Parámetros

Authorization
header
stringObligatorio

Bearer $CLOBEPAY_API_KEY. También se acepta X-API-Key con el mismo valor. No envíes ambos.

walletId
path
uuidObligatorio

UUID de la billetera.

Respuestas

  • HTTP 200Detalle (addressLast6 y addressMasked, sin la dirección completa).

Errores

  • HTTP 400ambiguous_credentialsAuthorization: Bearer y X-API-Key traen llaves distintas.
  • HTTP 401missing_credentialsNo enviaste la llave (Authorization: Bearer o X-API-Key).
  • HTTP 401invalid_api_keyLa llave no existe, está mal formada o no coincide.
  • HTTP 401api_key_revokedLa llave fue revocada.
  • HTTP 401api_key_expiredLa llave expiró.
  • HTTP 401api_key_wrong_environmentLa llave es de otro ambiente (llave de prueba en producción o al revés).
  • HTTP 403insufficient_scopeLa llave no tiene el scope de esta ruta.
  • HTTP 429rate_limitedDemasiadas peticiones. Respeta Retry-After.
  • HTTP 404not_foundNo existe o no es tuya. También si walletId no es un UUID.
GET/crypto-beneficiaries/{walletId}
curl -X GET "$CLOBEPAY_API_BASE/crypto-beneficiaries/a41c82e7-3b6d-4c90-9e2a-5f17d0b8c4e3" \  -H "Authorization: Bearer $CLOBEPAY_API_KEY"

Respuesta

HTTP 200
Detalle (addressLast6 y addressMasked, sin la dirección completa).