> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.recurrente.com/referencia-api/api-reference/connected-accounts/create-connected-account-withdrawal/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.recurrente.com/_mcp/server. # Crear un retiro para una cuenta conectada POST https://app.recurrente.com/api/connected_accounts/{connected_account_id}/withdrawals Content-Type: application/json > **Obsoleto:** usa el endpoint unificado [`POST /transfers`](/api-reference/transfers/crear-una-transferencia) con `X-ACCOUNT-ID` y `destination: {type: bank_account, id: ...}`. Este endpoint sigue funcionando para integraciones existentes. Crea un retiro (payout) para una cuenta conectada (hija), pagando a una de las cuentas bancarias de la hija. Requiere movimiento de dinero habilitado en la llave de la plataforma. Reference: https://docs.recurrente.com/referencia-api/api-reference/connected-accounts/create-connected-account-withdrawal ## Authentication - `X-SECRET-KEY` header (required) — Tu clave secreta de API. Una llave de cuenta (`sk_live_...`, `sk_test_...`) opera sobre su propia cuenta y, con `X-ACCOUNT-ID`, sobre sus cuentas conectadas. La llave también fija el ambiente: una `sk_test_` solo lista y resuelve objetos de prueba (`live_mode: false`) y una `sk_live_` solo objetos reales. Un ID del otro ambiente responde `404` (`401` en `/customers`). Una llave de organización (`sk_org_live_...`, `sk_org_test_...`) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con `X-ACCOUNT-ID`; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde `403` con `code: organization_key_unsupported`. ## Request ### Path parameters - `connected_account_id` (string, required) ### Headers - `Idempotency-Key` (string, optional) — Clave de idempotencia para reintentos seguros de operaciones críticas, especialmente las que mueven dinero o cambian estado operativo. Reintentar con la misma clave y el mismo cuerpo devuelve la respuesta original (header `Idempotency-Replayed: true`); reusarla con parámetros distintos devuelve 409. ### Body (application/json) This endpoint expects an object. - `bank_account_id` (string, required) - `amount_in_cents` (integer, required) - `currency` (enum, optional) - Allowed values: `GTQ`, `USD` - `is_instant` (boolean, optional) ## Response ### 201 Retiro creado (asíncrono) - `id` (string, optional) - `status` (enum, optional) - Allowed values: `pending`, `approved`, `in_review`, `review_requested`, `sent`, `completed`, `rejected`, `cancelled` - `amount_in_cents` (integer, optional) - `currency` (string, optional) - `bank_name` (string, optional) - `note` (string, optional, nullable) — Nota del retiro - `recipient_email` (string, optional, nullable) — Correo del beneficiario al que le avisamos el estado del retiro - `tracking_url` (string, optional, nullable) — Página pública de seguimiento para el beneficiario - `created_at` (datetime, optional) - `bank_account` (BankAccount, optional) ## Errors ### 400 Bad Request Error Retiro inválido; por ejemplo, la cuenta bancaria destino tiene un formato inválido - `message` (string, optional) — Mensaje de error - `code` (string, optional) — Código estable legible por máquinas, cuando aplica - `refund_id` (string, optional) — ID del reembolso relacionado cuando aplica - `endpoint` (string, optional) — Acción de API rechazada, cuando aplica - `errors` (ErrorErrors, optional) — Detalles de errores por campo ### 422 Unprocessable Entity Error La operación no está disponible para esta cuenta - `message` (string, optional) — Mensaje de error - `code` (string, optional) — Código estable legible por máquinas, cuando aplica - `refund_id` (string, optional) — ID del reembolso relacionado cuando aplica - `endpoint` (string, optional) — Acción de API rechazada, cuando aplica - `errors` (ErrorErrors, optional) — Detalles de errores por campo ## Types ### BankAccount - `id` (string, optional) — ID único de la cuenta bancaria - `bank_name` (string, optional, nullable) — Nombre del banco - `holder_name` (string, optional) — Nombre del titular - `created_at` (datetime, optional) — Fecha de creación - `status` (enum, optional) — Estado de la cuenta bancaria - Allowed values: `active`, `archived` - `currency` (enum, optional) — Moneda de la cuenta bancaria - Allowed values: `GTQ`, `USD` - `account_type` (enum, optional, nullable) — Tipo de cuenta bancaria - Allowed values: `checking`, `savings` - `is_preferred` (boolean, optional) — Indica si es la cuenta preferida para su moneda - `ownership_type` (enum, optional) — Tipo de cuenta bancaria - Allowed values: `external`, `virtual` ### ErrorErrors Detalles de errores por campo ## Examples **Request** ```json { "bank_account_id": "string", "amount_in_cents": 1 } ``` **Response** ```json { "id": "wi_ab12cd34", "status": "pending", "amount_in_cents": 50000, "currency": "GTQ", "bank_name": "Banco Industrial", "note": "string", "recipient_email": "maria@example.com", "tracking_url": "https://app.recurrente.com/t/3xK9mPq2vLn8RtWz4Yb7Hc", "created_at": "2024-01-15T09:30:00Z", "bank_account": { "id": "ba_lmgbvesmihkqzma3", "bank_name": "Banco Industrial", "holder_name": "Acme Restaurant, S.A.", "created_at": "2024-01-15T09:30:00Z", "status": "active", "currency": "GTQ", "account_type": "checking", "is_preferred": true, "ownership_type": "external" } } ``` **SDK Code** ```python import requests url = "https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals" payload = { "bank_account_id": "string", "amount_in_cents": 1 } headers = { "X-SECRET-KEY": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals'; const options = { method: 'POST', headers: {'X-SECRET-KEY': '', 'Content-Type': 'application/json'}, body: '{"bank_account_id":"string","amount_in_cents":1}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals" payload := strings.NewReader("{\n \"bank_account_id\": \"string\",\n \"amount_in_cents\": 1\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-SECRET-KEY", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-SECRET-KEY"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"bank_account_id\": \"string\",\n \"amount_in_cents\": 1\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals") .header("X-SECRET-KEY", "") .header("Content-Type", "application/json") .body("{\n \"bank_account_id\": \"string\",\n \"amount_in_cents\": 1\n}") .asString(); ``` ```php request('POST', 'https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals', [ 'body' => '{ "bank_account_id": "string", "amount_in_cents": 1 }', 'headers' => [ 'Content-Type' => 'application/json', 'X-SECRET-KEY' => '', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals"); var request = new RestRequest(Method.POST); request.AddHeader("X-SECRET-KEY", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"bank_account_id\": \"string\",\n \"amount_in_cents\": 1\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-SECRET-KEY": "", "Content-Type": "application/json" ] let parameters = [ "bank_account_id": "string", "amount_in_cents": 1 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.recurrente.com/api/connected_accounts/connected_account_id/withdrawals")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```