Saltar al contenido principal
POST
Cancelar deudas en lote

Autorizaciones

x-api-key
string
header
requerido

API key del API Gateway de Tapi. Requerida en todas las operaciones. Distinta por ambiente (desarrollo, homologación, producción).

x-authorization-token
string
header
requerido

Token TAPI JWT. Requerido en todas las operaciones. Se envía sin prefijo "Bearer". Ej: x-authorization-token: eyJhbGci...

Parámetros de consulta

companyCode
string

Solo si tu cliente tiene varias companies: indica en cuál operas. En POST y PATCH también se puede enviar en el cuerpo (el cuerpo tiene prioridad). Si tu cliente tiene varias companies y no lo envías, 400 BAD_REQUEST; si no es una company de tu cliente, 422 RESOLUTION_ERROR (403 en /v2/debts/orders).

Ejemplo:

"MX-S-67890"

Cuerpo

application/json

Lote de hasta 50 deudas a cancelar en un solo request. En el nivel superior solo se acepta debts (y companyCode): cualquier otro campo devuelve 400. Cada item solo lleva id. Si un item es inválido no se cancela ninguna deuda, y cada entrada de details[] trae index, field e issue.

debts
object[]
requerido
Required array length: 1 - 50 elements

Respuesta

Todas las deudas quedaron canceladas. data las trae en el orden enviado y no viene errors.

data
object[]

Deudas canceladas, en el orden en que fueron enviadas, incluidas las que ya estaban canceladas. paymentUrl viene en null: una deuda cancelada ya no se paga.

errors
object[]

Deudas que no se cancelaron o cuya cancelación no se pudo confirmar. Solo viene si hay alguna.

requestId
string