Aicscan Documentation
FrançaisEnglish

Pay: webhooks

Get a Pay event and its deliveries

GET/v1/events/{id}
Authentication
API key (Authorization: Bearer)
Required scope
pay:read

Path parameters#

  • idstringrequired

    evt_ followed by 32 lowercase hex digits (same value as the X-Event-Id webhook header).

    ^evt_[0-9a-f]{32}$

Responses#

200Event, as delivered by webhook, plus deliveries.
Object fields
  • idstring

    evt_…, identical on every retry and resend.

  • typestring
    Values invoice.created invoice.confirming invoice.paid invoice.underpaid invoice.overpaid invoice.expired invoice.paid_late invoice.canceled invoice.reverted invoice.held sweep.succeeded sweep.failed refund.succeeded refund.pending merchant.payout_change_requested merchant.payout_changed merchant.frozen merchant.kyb_updated
  • api_versionstring
  • environmentstring
    Values test live
  • livemodeboolean
  • created_atstring · date-time
  • dataobject
    Object fields
    • objectobject

      The invoice, sweep, refund or merchant.

    • paymentobject

      On-chain payment events: amount, from, chain_id, tx_hash, log_index, block_number, confirmations.

  • deliveriesarray of object
    Fields of each item
    • endpoint_idstring · uuid
    • statusstring
      Values pending delivering succeeded failed
    • attemptsinteger
    • next_attempt_atstring · date-time
    • last_attempt_atstring · date-timenullable
    • last_status_codeintegernullable
    • last_errorstringnullable
    • give_up_atstring · date-time
4xx · 5xxError.

Standard error format: see Errors.