Transaction event notification

Authorizations

Authorization

string

header

required

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Headers

X-IMPRINT-HMAC-SIGNATURE

string

required

HMAC signature generated using webhook secret and webhook payload

Body

application/json

object

enum<string>

The type of object associated with this webhook event. This field indicates what kind of resource has been created or updated.

Available options:

TRANSACTION

Example:

"TRANSACTION"

data

object

Show child attributes

data.transaction_id

string

Unique identifier for the transaction. transaction_id remains the same throughout the lifecycle of a transaction (e.g., from APPROVED to CAPTURED or REFUNDED). It represents the overarching transaction instance.

Example:

"e2806932-5f1b-4518-8b15-156d773e9496"

data.event_id

string

Unique identifier for a specific event that occurs within a transaction’s lifecycle. Transaction events correlated with a status (e.g., APPROVED, UPDATED, CAPTURED, REFUNDED), and every event is uniquely identified by an event_id.

Example:

"e2806932-5f1b-4518-8b15-156d773e9496"

data.intent_id

string | null

Unique identifier of the transaction intent.

Example:

"intent-12345"

data.payment_method_id

string

Unique identifier of the payment method used.

Example:

"7f754378-dd84-4a9a-b1ce-0646bb769c29"

data.customer_id

string

Unique identifier of the customer.

Example:

"e0549550-90e9-4acb-b7e9-2e4738b7def2"

data.partner_customer_id

string

The unique identifier for the customer in the partner's system

Example:

"PARTNER_USER_456"

data.status

enum<string>

Available options:

APPROVED,

UPDATED,

VOIDED,

CAPTURED,

REFUNDED

Example:

"APPROVED"

data.created_at

string<date-time>

RFC 3339 timestamp indicating when the transaction was authorized.

Example:

"2025-02-27T18:11:32.358Z"

data.updated_at

string<date-time> | null

RFC 3339 timestamp indicating when the transaction was last updated.

Example:

"2025-02-27T18:15:00.000Z"

data.amount

integer

Amount of the transaction in the smallest currency unit (e.g., cents for USD).

Example:

5000

data.currency

string

The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")

Example:

"USD"

data.authorization_code

string | null

Code used to authorize the transaction.

Example:

"645432"

data.network_transaction_id

string | null

Unique transaction identifier assigned by the payment network.

Example:

"txn-789456"

data.purchase_method

enum<string> | null

How the purchase was completed.

Available options:

CHIP,

CONTACTLESS,

KEYEDIN,

ONLINE,

SWIPE,

QRCODE,

OCR,

UNKNOWN

Example:

"CHIP"

data.merchant

object

Show child attributes

data.merchant.network_id

string

Unique identifier of the merchant assigned by the payment network.

Example:

"234923454545"

data.merchant.name

string

Name of the merchant where the transaction occurred.

Example:

"Target"

data.merchant.category

string | null

Name of the merchant category.

Example:

"Grocery Stores"

data.merchant.category_code

string | null

Code associated with the merchant category.

Example:

"5411"

data.merchant.address

object

Mailing address information

Show child attributes

data.merchant.address.street_line1

string

Primary street address

Example:

"123 Main St"

data.merchant.address.street_line2

string

Secondary street address (apartment, suite, etc.)

Example:

"Apt 4B"

data.merchant.address.city

string

City name

Example:

"San Francisco"

data.merchant.address.state

string

State or province

Example:

"CA"

data.merchant.address.postal_code

string

ZIP or postal code

Example:

"94105"

data.merchant.address.country

string

ISO-3166-1 alpha-3 Country Code

Example:

"USA"

Response

200 - text/plain

Webhook received successfully.

The response is of type string.

Basics

API Reference

Transaction event notification

Authorizations

Headers

Body

Response