Payment method 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:

PAYMENT_METHOD

Example:

"PAYMENT_METHOD"

data

object

Show child attributes

data.payment_method_id

string

Unique identifier for the payment method.

Example:

"DCBFC736-2286-42DD-897D-160DCA80AED2"

data.customer_id

string

Unique identifier for the associated customer

Example:

"2EE24580-B97B-4949-A65C-929CCB9B9B8D"

data.partner_customer_id

string

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

Example:

"PARTNER_USER_456"

data.previous_status

enum<string>

The previous status of the card.

Available options:

ACTIVE,

INACTIVE,

CANCELED

data.new_status

enum<string>

The new status of the card

Available options:

ACTIVE,

INACTIVE,

CANCELED

data.card_type

enum<string>

The type of card

Available options:

PHYSICAL,

VIRTUAL

data.card_design_id

string

Imprint ID for the graphic design printed on the card

Example:

"3b9c1f3e-52a0-44c1-b131-a7ab0099a214"

data.tokens

object[]

Payment method tokens that are defined by a third-party provider are included in this array by Imprint.

Show child attributes

data.tokens.type

enum<string>

required

Available options:

ADYEN,

APPLE_WALLET

data.tokens.token

string

required

The token, as defined by the processor

data.tokens.created_at

string

required

the RFC-3339 timestamp when the payment method was created

Example:

"2025-02-13T19:08:07.000Z"

data.tokens.updated_at

string

required

the RFC-3339 timestamp when the payment method was updated

Example:

"2025-02-13T19:08:07.000Z"

data.tokens.pan_reference_id

string

An ID that represents the PAN and is defined by the processor

data.created_at

string

the RFC-3339 timestamp when the payment method was created

Example:

"2025-02-13T19:08:07.000Z"

data.updated_at

string

the RFC-3339 timestamp when the payment method was updated

Example:

"2025-02-13T19:08:07.000Z"

Response

200 - text/plain

Webhook received successfully.

The response is of type string.

Basics

API Reference

Payment method event notification

Authorizations

Headers

Body

Response