API Reference
...
Butter Disputes API
Merchant Analytics

Merchant Analytics Requests

1min
POST
/v1/analytics/

This endpoint is used to get customer analytics from the merchant's server-side checkout flow.

The following are required fields:

  • customer_email: A valid email address for the customer associated with the transaction.
  • ipv4_address: The IPV4 address of the customer found in the request headers during checkout.
  • psp: The payment service provider used to process the transaction.

The following are conditionally required fields, at least one must be present, the more information provided the more accurate dispute matching will be:

  • invoice_id: The invoice ID associated with the transaction in the respective PSP.
  • subscription_id: The subscription ID associated with the transaction in the respective PSP.
  • charge_id: The charge ID associated with the transaction in the respective PSP.
  • transaction_id: The transaction ID associated with the transaction in the respective PSP.
  • network_transaction_id: The network transaction ID associated with the transaction in the respective card network.

The following are optional fields:

  • customer_id: The customer ID associated with the transaction in the respective PSP.
Authentication
HTTPBasic
Body Parameters
body
*
customer_email
*
ipv4_address
*
psp
*
user_agent
customer_id
invoice_id
subscription_id
charge_id
transaction_id
network_transaction_id
Responses
200
Successful Response
id
*
422
Validation Error
detail




Updated 23 Aug 2024
Doc contributor
Did this page help you?