Saltar al contenido principal
POST
Solicita un retiro

Autorizaciones

Authorization
string
header
requerido

Tu llave de API, enviada como Authorization: Bearer <key>. Las llaves reales y de prueba son distintas; la llave que envías decide en qué modo actúa la llamada. Para probar llamadas, usa una llave de prueba (empieza con lst_test_): no se envía ningún repartidor real y no se mueve dinero real, pero los webhooks se disparan y el dropoff.phone que des puede recibir mensajes de WhatsApp, así que usa tu propio número. Una llave real (empieza con lst_live_) reserva y cobra envíos reales.

Cuerpo

application/json

Cuánto mover de tu saldo.

amount_cents
integer
requerido

Lo que recibe tu banco, en centavos.

Rango requerido: x >= 1
kind
enum<string> | null

Por omisión es standard.

Opciones disponibles:
standard,
same_day,
null

Respuesta

Creado.

Una solicitud para mover dinero de tu saldo a tu cuenta bancaria.

id
string
requerido

El id del retiro, con prefijo wd_.

Ejemplo:

"wd_2xN6bK9mR4tQ7vC1sZ8pLwYe"

amount_cents
integer
requerido

Lo que recibe tu banco. En un retiro same_day la tarifa es un SEGUNDO cargo en lugar de una deducción, así que esta cifra es lo que llega en cualquiera de los dos casos, y fee_cents es lo que tu saldo pierde encima de ella.

fee_cents
integer
requerido

Cuánto costó el retiro, con IVA incluido. Siempre 0 en un retiro standard. Siempre está presente.

currency
enum<string>
requerido
Opciones disponibles:
MXN
kind
enum<string>
requerido

standard es la vía gratuita: solo tu saldo liberado, enviado en 1 a 3 días hábiles. same_day cuesta fee_cents, puede alcanzar efectivo que todavía está retenido, y se envía el mismo día dentro de los horarios indicados en POST /v1/withdrawals.

Opciones disponibles:
standard,
same_day
status
enum<string>
requerido

pending hasta que una persona lo liquide. El paso a paid o failed es lo que anuncia withdrawal.updated.

Opciones disponibles:
pending,
paid,
failed
requested_at
string<date-time> | null
requerido
due_at
string<date-time> | null
requerido

Cuándo se espera que se haya enviado un retiro same_day, sellado cuando lo solicitaste y nunca recalculado después. Es null en cada retiro standard: la vía gratuita promete un rango de días hábiles en lugar de un instante.

resolved_at
string<date-time> | null
requerido

Null mientras siga pendiente.

clave_de_rastreo
string | null
requerido

La clave de rastreo SPEI de la transferencia: el identificador que tu propio banco usa para localizar el depósito. Es con lo que concilias un pago contra un estado de cuenta bancario, y es la misma clave que ves en el panel de este retiro.

Siempre está presente, y es null hasta que se envía la transferencia. Se queda en null para siempre en un retiro failed, porque nunca hubo transferencia.

Ejemplo:

"MBAN01002608120001234567"

test
boolean
requerido