Cuentas y CVU
Consulta de tu cuenta de recaudación (PSP) y gestión de los CVU asociados.
GET /api/v1/account/psp — Obtener cuenta de recaudación
Sin body ni params (la cuenta se resuelve desde tu key).
Respuesta:
{
"account_id": "3f9a1c2e-...",
"name": "ACME SA",
"tax_number": "30711111118",
"currency_id": "ARS",
"psp_reference": null,
"collection_account_reference": null,
"uan": "0000003100010000000001"
}
uan es el CBU/CVU de la cuenta.
PUT /api/v1/account/psp — Actualizar alias del PSP
Body:
| Campo | Tipo | Requerido | Notas |
|---|---|---|---|
alias | string | sí | 6–20 caracteres |
Ejemplo: { "alias": "acme.pagos" }
Respuesta: { "account_id": "...", "alias": "acme.pagos" } o el envelope de operación. Devuelve un error si se reusa la clave de idempotencia (ver Errores).
POST /api/v1/account/cvu — Crear CVU
Crea un CVU en tu cuenta de recaudación. Por defecto queda asociado al cliente de la
API key; si enviás client_id, queda asociado a ese cliente.
Body
| Campo | Tipo | Requerido | Notas |
|---|---|---|---|
client_id | string (uuid) | no | Cliente dueño del CVU. Si se omite, se usa el de la account de la API key. Obligatorio solo si esa account no tiene client_id |
currency_id | enum | no | ARS (default), USD o EUR |
alias | string | no | 6–20 caracteres (letras, números, . y -) |
reference | string | no | máx. 255 (nombre de fantasía) |
config | objeto | no | Opcional; pares clave→valor (string/number/boolean) para configs del contrato |
Ejemplo típico:
{
"client_id": "3f9a1c2e-8b4d-4a1e-9c7f-1122aabbccdd",
"reference": "cvuzilo999",
"alias": "testzilo9999",
"currency_id": "ARS"
}
Headers habituales (x-idempotency, firma, etc.): ver Autenticación.
Respuesta
Envelope { operation_core, operation_status_id, error, response }:
| HTTP | Cuándo |
|---|---|
| 200 | Completado OK |
| 202 | Sigue en curso — si hay operation_core, consultar GET /operation/:operation_id |
| 4xx | Falló |
GET /api/v1/account/cvu/:identifier? — Obtener o listar CVU
Con identifier (AccountIdentifier: UUID / CVU / Alias): devuelve un CVU.
Sin identifier: modo listado. Query page (default 1) y limit (default 10, máx 100).
Item de CVU:
{
"account_id": "3f9a1c2e-...",
"uan": "0000003100010000000009",
"alias": "acme.caja01",
"network": "coelsa",
"reference": "Caja 01",
"client": { "client_id": "...", "name": "ACME SA", "tax_number": "30711111118" },
"currency": "ARS"
}
En modo listado la respuesta es { "data": [ /* items */ ], "pagination": { ... } }.
PUT /api/v1/account/cvu/:identifier — Actualizar alias del CVU
Actualiza el alias del CVU indicado.
Path params
| Param | Tipo | Requerido | Notas |
|---|---|---|---|
identifier | AccountIdentifier | sí | UUID del CVU, número CVU/CBU (22 dígitos) o alias actual |
Body
| Campo | Tipo | Requerido | Notas |
|---|---|---|---|
alias | string | sí | 6–20 caracteres; letras, números, . y - |
Ejemplo:
{ "alias": "acme.caja02" }
Headers habituales de la API (x-idempotency, firma, etc.): ver Autenticación.
Respuesta
Envelope { operation_core, operation_status_id, error, response }
(200 / 202 / 4xx). Si sigue en curso y hay operation_core:
GET /operation/:operation_id.
Conflicto de idempotencia: ver Errores.
DELETE /api/v1/account/cvu/:identifier — Dar de baja un CVU
Deprecia el CVU indicado (baja lógica).
Path params
| Param | Tipo | Requerido | Notas |
|---|---|---|---|
identifier | AccountIdentifier | sí | UUID del CVU, número CVU/CBU (22 dígitos) o alias |
Body
Opcional. En el caso habitual no hace falta body: se usa la cuenta de recaudación de tu API key.
| Campo | Tipo | Requerido | Notas |
|---|---|---|---|
account_id | string (uuid) | no | Solo si querés indicar otra cuenta de recaudación distinta a la de la key |
Ejemplo sin body: DELETE /api/v1/account/cvu/acme.caja01
Ejemplo con body:
{ "account_id": "3f9a1c2e-8b4d-4a1e-9c7f-1122aabbccdd" }
Headers habituales de la API (x-idempotency, firma, etc.): ver Autenticación.
Respuesta
Envelope { operation_core, operation_status_id, error, response }
(200 / 202 / 4xx). Si sigue en curso y hay operation_core:
GET /operation/:operation_id.