Webhooks

Configuration

Clients can configure individual webhook URLs per event type at Paysight Account Settings

Available Event Types

Event Type	Description
New Transaction	Triggered when a new billing event occurs (authorize, sale, refund, chargeback, or alert).
Updated Transaction	Triggered when an existing authorized transaction is captured or cancelled. The `status`, `statusId` and `completed` fields will be updated. Please note: You will not receive an updated transaction for transactions that are refunded / charged back. You will receive these in the New Transaction event webhook as they are a separate transaction but can be linked back to the original tranaction (see above)
New Subscription	Triggered when a new customer subscription is created.
Cancelled Subscription	Triggered when a subscription is cancelled.
Chargeback Alert	Raw unmatched chargeback alerts from mitigation provider.
Chargeback	Raw unmatched chargeback records reported against the client.

For New Transaction event type, the important properties are:

transactionId
orderId
originalTransactionId - if the transaction is a Refund, Chargeback Alert or Chargeback then the OriginalTranactionId will be provided which references the tranaction that was refunded/charged back These transactions can be identfied via the applicationId property listed below and will have a negative amount value:
- Refund - applicationId = 200
- Chargeback - applicationId = 201
- Chargeback Alert - applicationId = 202

Delivery & Performance

HTTP Method: Webhooks are delivered via HTTP POST to the configured URLs.
Batch Delivery: Webhooks are sent as arrays of event objects.
Response Time: Your server must respond with HTTP 200 OK within 2 seconds.
No Inline Processing: Please queue events for asynchronous processing.

Payload Structure

New Transaction / Updated Transaction

Session correlation fields for transaction webhooks:

paysightSession: Paysight-generated session identifier
partnerSession: your external session/click/visit identifier from Card Submit partnerSession
Widget integrations: Widget sessionId is sent to Card Submit as partnerSession

[
    {
      "gateway": "NMI",
      "transactionId": "90a0bbed-752a-4445-8112-b44de14a865c",
      "orderId": 193777233,
      "sent": "2025-06-18T16:01:04",
      "email": "johnsmith@hotmail.com",
      "sandbox": false,
      "applicationId": 6,
      "status": "None",
      "statusId": 0,
      "success": false,
      "completed": "2025-06-18T16:01:04",
      "currency": "USD",
      "amount": 0,
      "mid": "56220000192222",
      "descriptor": "genericthing.com",
      "customerId": 39306678,
      "authCode": "",
      "gatewayTransactionId": "",
      "firstName": "John",
      "lastName": "Smith",
      "bin": "468831",
      "last4": "9471",
      "refunded": false,
      "refundable": false,
      "hasAlert": false,
      "chargedBack": false,
      "application": "Sub Start",
      "applicationId2": 216,
      "application2": "Opt In",
      "shopId": 0,
      "storeName": "",
      "storeDomain": "",
      "storeRootDomain": "",
      "merchantAccountId": 831,
      "midName": "US - Generic Merchant - CBCal",
      "companyId": 182,
      "company": "Acme Limited",
      "parentCompanyId": 981,
      "subscriptionId": 8402,
      "subscription": "Acme Subscription",
      "refundSourceId": 0,
      "alertTypeId": 0,
      "alertSourceId": 0,
      "submitOrderId": 193777261,
      "alertSource": "Unassigned",
      "alertType": "Unassigned",
      "refundSource": "Unassigned",
      "binCountry": "US",
      "ipCountry": "US",
      "campaignId": 0,
      "campaign": "None/Unassigned",
      "affiliateId": 0,
      "affiliate": "None",
      "productId": 8469,
      "product": "Acme Main Landing Page",
      "paymentNumber": 0,
      "attempt": 1,
      "originalTransactionId": null,
      "containsSalesStrategy": false,
      "networkTokenized": false,
      "chargebackFee": 0,
      "cardBrandId": 1,
      "cardBrand": "Visa",
      "eci": "02",
      "paysightSession":"202602231518583780223233",
      "partnerSession":"fds9Pam2fj-291",
      "applePay": true,
      "googlePay": false
    }
]

Field Descriptions for Transaction Events

string

NMI/Payon/EmerchantPay etc

string

Paysight’s unique identifier for the transaction (also referred to as messageId)

number

The unique order refrerence to which the transaction relates. This will match the orderId returned in the original widget/card submit response

string

Timestamp in GMT when transaction was initiated

string

User Email address

boolean

Indicates if transaction was simulated (sandbox=true) or real (sandbox=false)

number

Paysight’s unique identifier of the transaction type

string

Status of the transaction

number

Paysight’s unique identifier of the status of the transaction

boolean

Indicates if the billing event was successful (fully captured funds or successful refund etc)

string

Timestamp in GMT when transaction was finalized

string

Transaction currency (e.g ‘USD’)

number

Transaction amount (e.g 9.99)

string

Merchant Account Identifier

string

Merchant Account Descriptor

number

Paysight Customer Id

string

Gateway Authorization code

string

Gateway Transaction Id

string

Customer First Name

string

Customer Last Name

string

Card Bin (first 6 digits)

string

Card Last 4 digits

boolean

Indicates if Transaction has been refunded

boolean

Indicates if Transaction is refundable

boolean

Indicates if Transaction has a related Charegack alert

boolean

Indicates if Transaction was charged back

string

Paysight Transaction Type

number

Paysight Transaction Type 2 (classifies transactions in a similar way to above with some specific differences. Speak to support team for more info)

string

Identifier for above. Speak to support team for more info)

number

Shopify Store Id (if applicable)

string

Shopify Store Name (if applicable)

string

Shopify Store Domain (if applicable)

string

Shopify Store Root Domain (if applicable)

number

Paysight Identifier for Merchant Account

string

MID Name/Title/Description

number

Merchant Account Company Identifier

string

Merchant Account Company

number

Paysight Tenant Identifier (ClientId)

number

Paysight Subscription Identifier

string

Paysight Subscription Name

number

Identifier for Refund Source (if applicable)

number

Identifier for Alert Type (if applicable)

number

Identifier for Alert Source (if applicable)

number

Unique identifier of Card Submit event

string

Chargeback Mitigation Provider (e.g Kount)

string

Chargeback Alert Type, e.g RDR, Ethoca, CDRN

string

Source of Refund (if applicable) e.g Alert Related, Customer Service etc

string

Country Code associated with issuing Bin

string

Country code associated with user IP address (from original session)

number

Paysight unique identifier for Client’s campaign

string

Client’s campaign

number

Paysight unique identifier for Client’s traffic source/affiliate

string

Client’s traffic source/affilia

number

Paysight unique identifier for Product, which is the entry point and determines how a user should be handled

string

The Product contains the settings that determine how a user is handled/charged when they interact with Paysight via the Payment Widget / Card Submit API

number

Paysight Billing Cycle. Indicates the number of payments that the user has made on the applicable subscription. e.g 4 = User has made 3 previous payments before this one

number

attempt=1 is the first natural attempt. attempt=2 is the first retry. attempt=3 is the 2nd retry etc.

string

For refunds, chargebacks and chargeback alerts this is the reference to related transaction

boolean

Indicates if the eCom related order contained an upsell

boolean

Indicates if the transactions was network tokenized

number

Fee associated with Chargeback, if the transaction is a chargeback

number

1=Visa,2=Mastercard,3=Discover,4=Amex,5=Chase,6=JCB

string

Card Brand e.g Visa

string

For transactions with 3D Secure, the Electronic Commerce Indicator value. 02 and 05 are fully authenticated and there should be liability shift. 01 and 06 are attempted.

string

Unique identifier for the Paysight session associated with the transaction. This represents the session created and managed within Paysight during the user’s interaction (e.g. payment widget session).

string

Optional partner-provided session identifier. This can be used to correlate the transaction with the client’s own session, tracking, or analytics systems.

boolean

Indicates whether the transaction was processed using Apple Pay.

boolean

Indicates whether the transaction was processed using Google Pay.

New Subscription / Cancelled Subscription

[
    {
        "parentCompanyId": 106,
        "companyId": 125,
        "company": "Acme Corp Inc",
        "mid": "502231321321",
        "descriptor": "FitnessForAll.com",
        "subscriberId": 521254582,
        "customerId": 5898542245,
        "subDate": "2025-05-23T01:16:23",
        "unsubDate": "2025-06-19T10:24:53",
        "orderId": 85422140,
        "active": false,
        "unsubscribeOrderId": 0,
        "email": "jack@whitestripes.com",
        "subscriptionId": 8402,
        "subscription": "Generic Fitness Subscription",
        "productId": 8469,
        "product": "Fitness Landing Page 1",
        "frozen": false,
        "crossSale": false,
        "unsubscribeSource": "ChargebackAlert",
        "submitOrderId": 85422140
    }
]

Field Descriptions for Subscription Events

number

Paysight Tenant Identifier (ClientId)

number

Identifier for Merchant Account Company

string

Merchant Account Company

string

Merchant Account Identifier

string

MID Descriptor

number

Unique identifier for the customer’s specific subscription

number

Unique identifier for the customer

string (ISO 8601)

Timestamp in GMT when the user was subscribed

string (ISO 8601)

Timestamp in GMT when the user unsubscribed/cancelled

number

The unique order refrerence to which the transaction relates. This will match the orderId returned in the original widget/card submit response

boolean

True if the user has not yet cancelled or been unsubscribed

number

Unique identifier for the unsubscribe event (null if user has not yet unsubscribed)

string

Customer Email

number

Unique identifier for the Subscription (service) on Paysight

string

Name of the Subscription (service) on Paysight

number

Paysight unique identifier for Product, which is the entry point and determines how a user should be handled

string

The Product contains the settings that determine how a user is handled/charged when they interact with Paysight via the Payment Widget / Card Submit API

boolean

True if Paysight is no longer attempting to bill the customer (this will happen after retry strategies have been exhausted or specifc hard declines)

boolean

Indicates if user was added to the subscription as a cross sale (from another subscription)

string

Indicates how the user was unsubscribed. Values are:

ChargebackAlert
CustomerService

number

Unique identifier of Card Submit event

Chargeback Alert

The Chargeback Alert event webhook will provide a uniform feed of all chargeback alerts. This is still under development

[
    {
        // TBD
    }
]

Still in progress, stay tuned for more updates.

Chargeback

The Chargeback event webhook will provide a uniform feed of all chargeback alerts. This is still under development

[
    {
        // TBD
    }
]

Still in progress, stay tuned for more updates.

Best Practices

Always respond with HTTP 200 OK within 2 seconds.
Do not process payloads inline—queue them for background processing.
Log webhook events and delivery statuses.

Getting Started

Handbook

Configuration

Available Event Types

Delivery & Performance

Payload Structure

New Transaction / Updated Transaction

Field Descriptions for Transaction Events

New Subscription / Cancelled Subscription

Field Descriptions for Subscription Events

Chargeback Alert

Chargeback

Best Practices

​Configuration

​Available Event Types

​Delivery & Performance

​Payload Structure

​New Transaction / Updated Transaction

​Field Descriptions for Transaction Events

​New Subscription / Cancelled Subscription

​Field Descriptions for Subscription Events

​Chargeback Alert

​Chargeback

​Best Practices

Configuration

Available Event Types

Delivery & Performance

Payload Structure

New Transaction / Updated Transaction

Field Descriptions for Transaction Events

New Subscription / Cancelled Subscription

Field Descriptions for Subscription Events

Chargeback Alert

Chargeback

Best Practices