post
https://example.com/api/receipts/withdraw-requests
Crea una solicitud de extracción desde una cuenta comitente hacia una cuenta bancaria asociada.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Solicitá una extracción desde una cuenta comitente hacia una cuenta bancaria asociada.
Antes de empezar
- Tené a mano el
investment_account_idde la cuenta comitente que va a extraer fondos. - Verificá que la cuenta bancaria ya esté registrada y usá su
bank_account_id. - Definí la moneda de la extracción en
currency_id. - Generá un
external_idúnico para evitar duplicados y poder reconciliar la respuesta. - Si querés extraer el total disponible, enviá
is_total=true.
Cómo crear una solicitud de extracción
POST /api/receipts/withdraw-requests
Content-Type: application/jsonBody parameters
El body acepta un objeto WithdrawRequestInput.
| Campo | Tipo | Requerido | Default | Descripción |
|---|---|---|---|---|
investment_account_id | integer | Sí | — | Código de la cuenta comitente en ApiBroker. |
currency_id | string | Sí | — | Moneda de la extracción. |
amount | number | No | — | Importe a extraer. |
external_id | string | Sí | — | Identificador único de la petición. |
bank_account_id | integer | Sí | — | Código identificador de la cuenta bancaria destino. |
is_total | boolean | No | false | Si enviás true, la extracción se solicita por el total disponible de la cuenta. |
Consideraciones sobre amount e is_total
amount e is_total- Si querés extraer un monto específico, enviá
amountcon el importe deseado. - Si querés extraer el total disponible, enviá
is_total=true. - Cuando
is_total=true, el sistema toma el total disponible de la cuenta según sus validaciones internas.
Posibles estados de la extracción
status_id | Descripción |
|---|---|
IN_PROGRESS | La solicitud está en proceso. |
COMPLETED | La extracción fue completada. |
REJECTED | La extracción fue rechazada. |
NOT_SENT | La solicitud no fue enviada. |
RETRY | La solicitud quedó pendiente de reintento. |
SENDING_PENDING | La solicitud está pendiente de envío. |
EXTERNAL_COMPLETED | La operación fue completada externamente. |
Ejemplo de request
{
"investment_account_id": 74659,
"currency_id": "ARS",
"amount": 10000,
"bank_account_id": 34,
"external_id": "withdraw_ext_123",
"is_total": false
}Qué devuelve este endpoint
La respuesta devuelve un arreglo items. Cada elemento representa una solicitud de extracción procesada.
| Campo | Tipo | Descripción |
|---|---|---|
withdraw_request_id | integer | Código identificador de la solicitud de extracción. |
investment_account_id | integer | Código de la cuenta comitente. |
currency_id | string | Moneda de la extracción. |
amount | number | Importe solicitado. |
external_id | string | Identificador externo enviado en la request. |
status_id | string | Estado actual de la solicitud. |
status_message | string | Mensaje asociado al estado de la extracción. |
created_at | string | Fecha de creación de la solicitud. |
updated_at | string | Fecha de última actualización. |
bank_account_id | integer | Cuenta bancaria asociada a la extracción. |
is_total | boolean | Indica si la extracción fue solicitada por el total disponible. |
Respuesta esperada
{
"items": [
{
"withdraw_request_id": 501,
"investment_account_id": 74659,
"currency_id": "ARS",
"amount": 10000,
"external_id": "withdraw_ext_123",
"status_id": "IN_PROGRESS",
"status_message": "",
"created_at": "2026-04-22T12:30:00Z",
"updated_at": "2026-04-22T12:30:00Z",
"bank_account_id": 34,
"is_total": false
}
]
}Errores frecuentes
409 Conflict: existe un conflicto de negocio en la solicitud. Revisá saldo, cuenta bancaria y duplicados porexternal_id.422 Validation Error: alguno de los campos obligatorios tiene un formato inválido.
Siguiente paso
Usá GET /api/receipts/withdraw-requests/{withdraw_id} para consultar una solicitud puntual o GET /api/receipts/withdraw-requests?external_id={external_id} para buscarla por identificador externo.
