Skip to main content
Usa la API de Transfers para enviar dinero, encontrar destinatarios a los que puedes pagar, listar y obtener transferencias al conciliar movimientos de dinero, y previsualizar o canjear enlaces de reclamo. Suscríbete a transfer.completed y transfer.failed para conocer los resultados en lugar de consultar periódicamente. Cada cuenta participante puede suscribirse a estos eventos. transfer.created también se emite cuando se completa correctamente, no cuando empieza el procesamiento. Una transferencia fallida puede reintentarse con el mismo ID y completarse más tarde; obtén la transferencia para conciliar su estado actual. Una transferencia de saldo completada acredita el saldo disponible del destinatario, a menos que se aplique una fecha de liberación. Las transferencias financiadas con saldo pendiente conservan una fecha de liberación y acreditan el saldo pendiente; las reservas del destinatario o las retenciones por fraude aplicables pueden mantener los fondos no disponibles. succeeded confirma que la transferencia se completó, no que todos los fondos se puedan retirar.

Endpoints

Atributos

string
requerido
ID de la transferencia.
object | null
requerido
Importe acreditado al destinatario. Es null mientras la transferencia no se haya completado correctamente.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
string
requerido
Cuándo se creó la transferencia.
object | null
requerido
Cuenta de negocio o usuario que recibe la transferencia.

Propiedades

string
requerido
ID de la cuenta o del usuario.
string | null
requerido
URL del logo del negocio o del avatar del usuario. Es null cuando no hay ninguna imagen disponible.
string | null
requerido
Nombre visible del negocio o del usuario.
string
requerido
Si el perfil es una cuenta de negocio o un usuario.Opciones disponibles: account, user
string | null
requerido
Hora de fallo registrada. Es null a menos que la transferencia haya fallado.
string | null
requerido
Código de fallo legible por máquina. Es null a menos que la transferencia haya fallado.
string | null
requerido
Explicación del fallo. Es null a menos que la transferencia haya fallado.
object | null
requerido
Todas las comisiones de transferencia aplicables, incluido el recargo de la plataforma. Es null cuando el total autoritativo no está disponible.

Propiedades

string
requerido
El importe en unidades principales, como cadena decimal exacta. Por ejemplo, "10.00" son diez dólares. Es una cadena para que ningún número de coma flotante lo redondee en tránsito.
string
requerido
Código de divisa ISO 4217 de tres letras, en minúsculas.
integer
requerido
Cuántos decimales tiene el importe. Es la precisión con la que se ejecuta el propio cargo.
integer
requerido
Cuántos decimales se deben MOSTRAR. Normalmente es igual a decimals, y deliberadamente no siempre: COP se cobra en centavos pero se escribe en pesos enteros, por lo que es 2 y 0. Usa esto para dar formato al número en tu propia configuración regional.
object
requerido
Metadatos personalizados adjuntos a la transferencia.
string | null
requerido
Nota de la transferencia.
string
requerido
El tipo de objeto.
object | null
requerido
Cuenta de negocio o usuario que envía la transferencia.

Propiedades

string
requerido
ID de la cuenta o del usuario.
string | null
requerido
URL del logo del negocio o del avatar del usuario. Es null cuando no hay ninguna imagen disponible.
string | null
requerido
Nombre visible del negocio o del usuario.
string
requerido
Si el perfil es una cuenta de negocio o un usuario.Opciones disponibles: account, user
string
requerido
Estado actual de la transferencia. Una transferencia puede crearse en processing y liquidarse unos segundos después; consulta periódicamente Retrieve Transfer o escucha los webhooks transfer.completed y transfer.failed en lugar de tratar la respuesta de creación como definitiva. succeeded y failed son estados finales.Opciones disponibles: processing, succeeded, failed
string | null
requerido
Hora registrada de la transición actual. Es null cuando se desconoce la hora de la transición histórica.
string | null
requerido
Hora registrada en que se completó correctamente. Es null cuando se desconoce.
string
requerido
Página de seguimiento de la transferencia. Para verla es necesario iniciar sesión y tener acceso a la transferencia.
Transfer