Merchant Analytics Requests
1 min
POST
https://api.disputes.services.butterpayments.com/v1/analytics/
bodyobject
200Successful Response
422Validation Error
curl --request POST \
--url https://api.disputes.services.butterpayments.com/v1/analytics/ \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"customer_email": "",
"ipv4_address": "",
"psp": ""
}'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.