Integrating with ChargebackStop

ChargebackStop for Partners has extensive API and webhook capabilities.

Terminology

To understand how our API and platform work, it helps to learn these terms and their relationships.

Partner

Your partner account.

• In production, you’ll typically only have one.

Organisation

An organisation within your partner account.

• We recommend setting separate organisations for all your customers.

Membership

A membership of a user within an organisation.

• This enables your customers to log in to their organisation.

• If your integration does not include your customers logging into ChargebackStop platform in any form (including whitelabel solutions), you will not need to create any memberships.

Merchant

A merchant account within an organisation.

• If your customer has multiple merchant accounts with payment processors, create a separate merchant account for each one.

• When creating a new merchant, we strongly recommend passing external_id as their MID, CAID, or provider account ID. It helps you differentiate merchant accounts later on.

Integration

A connection with a data source (e.g. payment processor such as Stripe, Adyen, Shopify, etc.), or a custom orders integration if you decide to push orders to ChargebackStop using the Orders API.

• Integrations allow ChargebackStop to match incoming alerts to transactions, and (for payment-processor-based integrations) to automatically refund or cancel payments associated with alerts.

Enrolment

An enrolment with a dispute prevention service (Ethoca or Verifi RDR).

• Creating an enrolment in the ChargebackStop platform starts the process of enrolling the merchant account with the selected service.

• Enrolment can span across multiple merchant accounts, e.g. when a single descriptor enrolled with Ethoca is used across multiple accounts.

Alert

An individual pre-dispute alert.

• An alert is always tied to an enrolment, as it’s the enrolment that’s the source of the alert.

Representment

A dispute case ingested via your payment processor.

• Only available if you choose to work with ChargebackStop for representment.

API

The ChargebackStop platform has an API that supports creating and managing all of the entities above.

You can read more about how to consume the API and onboard customers in our API integration guide page.

Webhooks

The ChargebackStop platform supports webhooks for the following events:

• alert.created

• alert.updated

• representment.created

• representment.updated

• fraud_notification.created

Full webhook documentation is available here: Webhooks

Webhooks can be tested using our Postman collection: https://www.postman.com/chargebackstop/chargebackstop/collection/2yu40q8/chargebackstop-webhooks. You can read more on the page linked above.