API Reference

overview the data collection api enables butter to collect the necessary information for every successful checkout, to block future dispute claims via order insight endpoint https //api disputes services butterpayments com/v1/analytics endpoint accepts post requests only authorization the data collection api uses basic auth your username and password for the basic auth credentials will be provided by butter during onboarding you will recieve two sets of credentials, one for testing (staging) and another for your production environment header authorization base64 encoded({username} {password}) additional headers header content type application/json payload { "customer email" "string", "ipv4 address" "string", "psp" "string", "customer id" "string", "invoice id" "string", "charge id" "string", "transaction id" "string", "subscription id" "string" } customer email required validation rule must be a valid email address ipv4 address required validation rule must be a valid ipv4 address format four sets of numbers, known as octets, separated by periods examples 127 0 0 1, 192 168 1 1 psp required the psp used to process the transaction accepted values stripe braintree adyen worldpay recurly recharge customer id optional an id that identifies the customer in your respective psp at least one of the following fields must be present, the more information provided the more accurate our matching capabilities will be invoice id an id that identifies the invoice associated with the successful checkout in your respective psp subscription id an id that identifies the subscriptions associated with the successful checkout in your respective psp charge id specific to merchants using stripe as a psp an id that identifies the charge associated with the successful checkout session transaction id an id that identifies the transaction associated with the successful checkout session can also be the network transaction id from the underlying card network notes merchants using stripe we encourage sending the invoice id and/or charge id for the best matching results responses 200 { "status" "ok" } 401 { "detail" "unauthorized" } 403 { "detail" "forbidden" }