WebhooksListar entregas

Listar entregas

GEThttps://api.copayex.com/api/v1/webhooks/deliveries

Parámetros de solicitud

CampoTipoUbicaciónRequeridoDescripción
subscriptionIdstringQueryNoID (string convertible a number).
status"pending" | "ok" | "fail" | "max_retries_reached"QueryNoEstado de entrega.

Estados:

  • pending: encolado para reintento.
  • ok: confirmado por el receptor.
  • fail: último intento falló pero quedan reintentos.
  • max_retries_reached: agotó reintentos automáticos.

Parámetros de respuesta

Devuelve una lista de entregas ([{ ... }]) con estos campos:

CampoTipoDescripción
idstringIdentificador del delivery.
subscriptionIdnumberSuscripción a la que corresponde.
eventIdnumberEvento que disparó el delivery.
attemptnumberNúmero de intento actual.
status"pending" | "ok" | "fail" | "max_retries_reached"Estado del delivery.
nextAttemptAtstring | nullFecha del próximo intento automático, null si no habrá más.
createdAtstring (ISO8601)Timestamp de creación.
attemptsAttempt[]Historial de intentos para el mismo delivery.

Tabla de Attempt:

CampoTipoDescripción
attemptnumberNúmero de intento (1, 2, …).
status"fail" | "ok"Resultado del intento.
responseCodenumber | nullCódigo HTTP devuelto por el receptor.
errorMessagestring | nullDetalle del error; si no está vacío, indica qué falló.
requestBodyobjectJSON enviado en ese intento (incluye type, datos del evento, etc.).
responseBodyobject | nullCuerpo devuelto por el receptor, si aplica.
durationMsnumberDuración del intento en milisegundos.
nextAttemptAtstring | nullFecha programada para el siguiente intento.
createdAtstring (ISO8601)Timestamp del intento.

Ejemplos de solicitud

curl -G "https://api.copayex.com/api/v1/webhooks/deliveries" \
  -H "Authorization: Bearer <client_access_token>" \
  --data-urlencode "status=pending"

Respuesta de ejemplo

[
  {
    "id": "27",
    "subscriptionId": 5,
    "eventId": 23,
    "attempt": 2,
    "status": "fail",
    "nextAttemptAt": "2025-11-11T21:53:45.000Z",
    "createdAt": "2025-11-12T00:50:36.613Z",
    "attempts": [
      {
        "deliveryId": "27",
        "subscriptionId": 5,
        "attempt": 2,
        "status": "fail",
        "responseCode": null,
        "errorMessage": "Error; connect ECONNREFUSED ::1:3443; connect ECONNREFUSED 127.0.0.1:3443",
        "requestBody": {
          "data": {
            ...
          },
          "type": "payments.item.partial_payment",
          "version": "1.0",
          "occurredAt": "2025-11-11T21:50:36.605Z"
        },
        "responseBody": null,
        "durationMs": 8,
        "nextAttemptAt": "2025-11-11T21:53:45.000Z",
        "createdAt": "2025-11-12T00:51:41.075Z"
      },
      {
    ...
      }
    ]
  }
]