Prismaterminals

Prisma terminals

Prisma terminal webhooks are emitted by the Payments API (btrz-api-payments) when Prisma terminal payments, reversals, refunds, or settlements are created or deleted (POST/DELETE on prisma-terminals endpoints).

Events

Action Event name
create a Prisma payment (POST /prisma-terminals/payments) prismaterminals.payment.created
delete a Prisma payment (DELETE /prisma-terminals/payments/:prismaPaymentId) prismaterminals.payment.deleted
create a Prisma reversal (POST /prisma-terminals/payments/:prismaPaymentId/reversals) prismaterminals.payment.reversals.created
delete a Prisma reversal (DELETE /prisma-terminals/reversals/:prismaPaymentId) prismaterminals.payment.reversals.deleted
create a Prisma refund (POST /prisma-terminals/payments/:prismaPaymentId/refunds) prismaterminals.payment.refunds.created
delete a Prisma refund (DELETE /prisma-terminals/refunds/:prismaPaymentId) prismaterminals.payment.refunds.deleted
create a Prisma settlement (POST /prisma-terminals/settlements) prismaterminals.settlements.created

Payload structure (all events)

Each event is emitted with the following top-level fields. The webhook delivery layer may add standard envelope fields (e.g. id, attemptId, livemode, created, event).

{
  "providerId": "string",
  "apiKey": "string",
  "data": {}
}

Payload fields

Field Type Description
providerId string Account ID of the account that performed the action (BETTEREZ_APP audience).
apiKey string API key used for the request (X-API-KEY header).
data object The resource returned by the API. Shape matches the corresponding response: payment created/deleted: same as GET /prisma-terminals/payments/:prismaPaymentId (id, requestDate, paymentStatus, paymentStatusDate, response). reversal created/deleted: same as GET /prisma-terminals/reversals/:prismaPaymentId (id, requestDate, reversalStatus, reversalStatusDate, response). refund created/deleted: same as GET /prisma-terminals/refunds/:prismaPaymentId (id, requestDate, refundStatus, refundStatusDate, response). settlement created: same as POST /prisma-terminals/settlements response (id, requestDate, settlementStatus, settlementStatusDate).