Safira Paydocs

Resend transaction webhook

POST /api/resend-webhook/{transactionIdentifier}

Resends the webhook of a specific transaction to the configured URL or to a temporary URL (override).

The transaction identifier can be:

  • Numeric transaction ID: The ID returned by Avista (transactionId field in webhooks)
  • Your reference ID: The identifier you provided when creating the transaction (externalId)
  • PIX End-to-End ID: The e2eId returned in webhooks (format: E/D + 32 chars)

Authentication

Requires a Bearer token in the Authorization header.

Path Parameters

ParameterTypeRequiredDescription
transactionIdentifierstringYesTransaction identifier: numeric id, externalId, or endToEndId

Request Body (optional)

FieldTypeRequiredDescription
urlstringNoTemporary URL for this specific resend. If not provided, uses the URL configured in the account webhook. The URL is not persisted
{
  "url": "https://meu-servidor.com/webhooks/avista"
}

URL Behavior

  • If url is provided in the body, uses that URL temporarily (not persisted)
  • If url is not provided, uses the URL configured in the account webhook for the operation type
  • If no URL is available, returns error 400

Response (200)

FieldTypeDescription
messagestringDescriptive message of the result
webhookLogIdnumberWebhook log ID generated for auditing
sentAtstringWebhook send date/time (ISO 8601)
statusCodenumberHTTP status code returned by the destination URL
{
  "message": "Webhook resent successfully",
  "webhookLogId": 12345,
  "sentAt": "2024-01-15T10:30:00.000Z",
  "statusCode": 200
}

Errors

StatusDescription
400No webhook URL available. Configure a webhook for this transaction's operation type or provide a temporary URL in the url field
401Invalid, expired, or missing token
404Transaction not found or does not belong to the authenticated account
429Rate limit exceeded (max 60 req/min)

On this page