Eliminar un beneficiario

Elimina un beneficiario específico cuando ya no lo necesites o cuando cambien los datos de la cuenta asociada. Identificas el registro con el userPaymentId que se devolvió al crear el beneficiario o que obtienes con GET /v2/payments. Los registros eliminados no se pueden recuperar: si necesitas volver a usar la misma cuenta, agrégala como un beneficiario nuevo.

Endpoint

DELETE https://api.velafi.com/v2/payments/{userPaymentId}

Usa https://api-test.velafi.com/v2/payments/{userPaymentId} para pruebas en sandbox.

Parámetros de ruta

integer

requerido

ID numérico único del beneficiario que quieres eliminar. Obtenlo del campo id en una respuesta de GET /v2/payments.

Campos de la respuesta

integer

Código de estado de la respuesta. 200 indica éxito.

string

Mensaje de respuesta legible.

boolean

true si el beneficiario se eliminó correctamente.

Ejemplo

curl -X DELETE "https://api.velafi.com/v2/payments/228" \
  -H "X-BH-TOKEN: YOUR_TOKEN"

{
  "code": 200,
  "msg": "SUCCESS",
  "data": true
}

Antes de eliminarlo, verifica que el userPaymentId no esté referenciado en ninguna orden activa o pendiente. Eliminar un beneficiario que está en uso puede causar problemas en el procesamiento de órdenes.

⌘I

Descripción general

Cuenta

Configuración

Comercios

Billetera cripto

Beneficiarios

Cotizaciones

Órdenes

Webhooks

Eliminar un beneficiario

Endpoint

Parámetros de ruta

Campos de la respuesta

Ejemplo

​Endpoint

​Parámetros de ruta

​Campos de la respuesta

​Ejemplo

Endpoint

Parámetros de ruta

Campos de la respuesta

Ejemplo