Skip to main content
POST
Transaction event webhook

Download OpenAPI specification

Body

application/json
id
string<uuid>

Unique system generated ID assigned to each event in the payment processing workflow. For example, an ID assigned to the initial authorisation event.

referenceTransactionEventId
string<uuid>

Unique ID assigned to VOID_AUTHORIZATION message category — applicable only for VOID_AUTHORIZATION.

transactionId
string<uuid>

Enfuce generated unique ID assigned to each card transaction. Transaction events for the same card payment includes the same transactionId. For example, authorisation, incremental authorisation, and adjustment for the same transaction includes the same transactionID.

messageCategory
enum<string>

Message category sent in the transaction event webhook. Possible enums:

  • INITIAL_AUTHORIZATION: Initial authorisation of the card payment.
  • INCREMENTAL_AUTHORIZATION: Additional authorisation for a previously authorised transaction.
  • DECLINED_AUTHORIZATION: Scheme declined the transaction on behalf of Enfuce in the STIP mode.
  • ADJUSTMENT: Corrections to a previously authorised transaction.
  • REVERSAL: Reversal of a previously authorised transaction.
  • BALANCE_INQUIRY: Enquiring about the current balance of the funding account from the external application.
  • PIN_MANAGEMENT: Request to change the card PIN.
  • PIN_MANAGEMENT_REVERSAL: Reversal of a pin change request.
  • FINANCIAL: Clearing message of batch payments.
  • PURGE_AUTHORIZATION: Excluded authorisations are purged after a specific period.
  • VOID_AUTHORIZATION: When an initial authorisation or an incremental authorisation request times out, a VOID_AUTHORIZATION message is generated.
  • ACCOUNT_STATUS_INQUIRY: When an account status is requested.
Available options:
INITIAL_AUTHORIZATION,
INCREMENTAL_AUTHORIZATION,
DECLINED_AUTHORIZATION,
ADJUSTMENT,
REVERSAL,
BALANCE_INQUIRY,
PIN_MANAGEMENT,
PIN_MANAGEMENT_REVERSAL,
FINANCIAL,
FINANCIAL_ADDENDUM,
FEE_COLLECTION,
RECONCILIATION,
PURGE_AUTHORIZATION,
VOID_AUTHORIZATION,
CHARGEBACK,
CHARGEBACK_REVERSAL,
REPRESENTMENT,
REPRESENTMENT_REVERSAL,
DOCUMENT_REQUEST,
ACCOUNT_STATUS_INQUIRY
messageFunction
enum<string>

Identifies the message function of the transaction event.

Available options:
REQUEST,
ADVICE,
NOTIFICATION,
ACCOUNT_STATUS_INQUIRY
clearingStatus
enum<string>

The status of the transaction. CLEARED means that the transaction has been fully cleared, PARTIALLY_CLEARED means that the transaction is partially cleared.

Available options:
CLEARED,
PARTIALLY_CLEARED
card
object

Information about the card used for the payment.

merchant
object
transaction
transactionEventTransaction · object
token
object

Information about the token associated with the card.

Response

Webhook successfully delivered.