Create Withdraw

Crea una solicitud de extracción desde una cuenta comitente hacia una cuenta bancaria asociada.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Solicitá una extracción desde una cuenta comitente hacia una cuenta bancaria asociada.

Antes de empezar

  1. Tené a mano el investment_account_id de la cuenta comitente que va a extraer fondos.
  2. Verificá que la cuenta bancaria ya esté registrada y usá su bank_account_id.
  3. Definí la moneda de la extracción en currency_id.
  4. Generá un external_id único para evitar duplicados y poder reconciliar la respuesta.
  5. 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/json

Body parameters

El body acepta un objeto WithdrawRequestInput.

CampoTipoRequeridoDefaultDescripción
investment_account_idintegerSí—Código de la cuenta comitente en ApiBroker.
currency_idstringSí—Moneda de la extracción.
amountnumberNo—Importe a extraer.
external_idstringSí—Identificador único de la petición.
bank_account_idintegerSí—Código identificador de la cuenta bancaria destino.
is_totalbooleanNofalseSi enviás true, la extracción se solicita por el total disponible de la cuenta.

Consideraciones sobre amount e is_total

  • Si querés extraer un monto específico, enviá amount con 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_idDescripción
IN_PROGRESSLa solicitud está en proceso.
COMPLETEDLa extracción fue completada.
REJECTEDLa extracción fue rechazada.
NOT_SENTLa solicitud no fue enviada.
RETRYLa solicitud quedó pendiente de reintento.
SENDING_PENDINGLa solicitud está pendiente de envío.
EXTERNAL_COMPLETEDLa 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.

CampoTipoDescripción
withdraw_request_idintegerCódigo identificador de la solicitud de extracción.
investment_account_idintegerCódigo de la cuenta comitente.
currency_idstringMoneda de la extracción.
amountnumberImporte solicitado.
external_idstringIdentificador externo enviado en la request.
status_idstringEstado actual de la solicitud.
status_messagestringMensaje asociado al estado de la extracción.
created_atstringFecha de creación de la solicitud.
updated_atstringFecha de última actualización.
bank_account_idintegerCuenta bancaria asociada a la extracción.
is_totalbooleanIndica 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 por external_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.

Body Params
integer
required

Investment account id

string
required
length between 3 and 5

Currency ISO-4217

number
string
required
length ≥ 1

External ID

integer
required

Bank account id

boolean
Defaults to false

If True, will withdraw the total available amount of the account. False by default.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json