Chargeback

Chargeback APIs provide seamless integration with chargeback management systems, enabling businesses to efficiently handle disputed transactions, build automated responses, and reduce the time spent on chargeback processing and resolution.

Power end-to-end data operations for your Chargeback API with Nexla. Our bi-directional Chargeback connector is purpose-built for Chargeback, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Chargeback or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Chargeback workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a Chargeback credential, you need to obtain authentication credentials from your Chargeback account. Chargeback uses Basic Authentication with a Public Key (username) and Secret Key (password) combination to authenticate API requests.

To use Chargeback with Nexla, you need:

• Access to your Chargeback account
• A Chargeback account with appropriate permissions to access the resources you want to work with
• Your Public Key and Secret Key for Basic Authentication
• The base URL for your Chargeback environment

The Chargeback API supports different environments, and you need to specify the appropriate base URL for your environment. Common base URLs include production and sandbox environments. For detailed information about Chargeback authentication, credential setup, and available environments, refer to the Chargeback API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Public Key	Yes	No	Public Key or User name
Secret Key	Yes	Yes	Secret key or password
Environment Base URL	Yes	No	To access the Chargeback API in different environments, change the base URL in your requests.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Chargeback

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Chargeback Public Key or username in the Public Key field. This is the Public Key or username associated with your Chargeback account that will be used for Basic Authentication.

4. Enter your Chargeback Secret Key or password in the Secret Key field. This is the Secret Key or password associated with your Chargeback account that will be used together with the Public Key for Basic Authentication.

5. Enter the base URL for your Chargeback environment in the Environment Base URL field. This should be the complete base URL of your Chargeback API environment, including the protocol (https://) but without any trailing slashes. To access the Chargeback API in different environments, change the base URL in your requests.

   Keep your authentication credentials secure and do not share them publicly. The credentials provide access to your Chargeback account and should be treated as sensitive information. Basic Authentication credentials are sent in the Authorization header for all API requests to the Chargeback API. The base URL determines which Chargeback environment your credential will access (e.g., production, sandbox, or other environments).

6. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Chargeback connector tile from the list of available connectors, then select the credential that will be used to connect to the Chargeback instance, and click Next; or, create a new Chargeback credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Chargeback endpoints. Each template is designed specifically for the corresponding Chargeback endpoint, making data source setup easy and efficient. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List resources

This endpoint returns a list of all resources that your key has access to. Use this endpoint when you need to access invoices, transactions, disputes, customers, or subscriptions from your Chargeback account.

• Select the resource type you want to retrieve from the Resource Type dropdown menu. Available options include:

  • invoices: Invoices to which the user has access to
  • transactions: Transactions to which the user has access to
  • disputes: Disputes to which the user has access to
  • customers: Customers in the user account
  • subscriptions: Subscriptions in the user account

  You can also add custom resource types if needed.

• The endpoint uses GET requests to {base_url}/{resource_type} where {base_url} is your Chargeback environment base URL from the credential configuration and {resource_type} is the selected resource type. The endpoint URL is automatically constructed based on your credential's base URL configuration and the selected resource type.
• The endpoint uses incrementing page-based pagination, automatically fetching additional pages as needed using the page and per_page query parameters. The endpoint starts from page 1 and continues fetching pages until all available resources have been retrieved. By default, the endpoint retrieves up to 200 items per page.
• The endpoint will return all resources of the selected type that your key has access to. The response data is extracted from the data array in the API response ($.data[*]), with each resource record processed individually.

This endpoint supports pagination through page and per_page query parameters. Nexla automatically handles pagination to retrieve all available records by incrementing the page number until no more data is returned. The endpoint uses incrementing page-based pagination (iteration.type: paging.incrementing), starting from page 1. By default, the endpoint retrieves up to 200 items per page (page.expected.rows: 200). The response data path is $.data[*], which extracts all items from the data array in the API response. You can add custom resource types if needed. For detailed information about retrieving resources, see the Chargeback API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Chargeback data sources can also be manually configured to ingest data from any valid Chargeback API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, path to data, and request headers.

Chargeback API endpoints typically follow the pattern {base_url}/{endpoint_path}, where {base_url} is your Chargeback environment base URL from the credential configuration. Chargeback API responses typically use a data array to contain the actual records — use $.data[*] as the Path to Data to extract all items. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. For detailed information, see the Chargeback API documentation.

Once all configuration steps have been completed, click the Save button to save your data source configuration. The data source will now be available in your data flow and will begin ingesting data according to the configured schedule and endpoint settings.

Use as a destination

Click the + icon on the Nexset that will be sent to the Chargeback destination, and select the Send to Destination option from the menu. Select the Chargeback connector from the list of available destination connectors, then select the credential that will be used to connect to the Chargeback organization, and click Next; or, create a new Chargeback credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Chargeback endpoints. Each template is designed specifically for the corresponding Chargeback endpoint, making destination setup easy and efficient. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create Resources

This endpoint creates resources in the chargeback user account. Use this endpoint when you need to create or update invoices, transactions, disputes, customers, or subscriptions from your data sources.

• Select the resource type you want to create or update from the Resource Type dropdown menu. Available options include:

  • invoices: Create or update (if already exists) an invoice
  • transactions: Create or update (if already exists) a transaction
  • disputes: Create or update (if already exists) a dispute
  • customers: Create or update a customer
  • subscriptions: Create or update a subscription

  You can also add custom resource types if needed.

• The endpoint uses POST requests to {base_url}/{resource_type} where {base_url} is your Chargeback environment base URL from the credential configuration and {resource_type} is the selected resource type. The endpoint URL is automatically constructed based on your credential's base URL configuration and the selected resource type.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the resource data to create or update. The request body should follow the Chargeback API specification for creating or updating resources, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create or update a resource. If you need to create or update multiple resources, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the Chargeback API specification for creating or updating resources. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For resources that already exist, the endpoint will update them if IDs are provided. You can add custom resource types if needed. For detailed information about creating or updating resources, including required fields, field names, and request formats, see the Chargeback API documentation.

Add line item

This endpoint adds a line item to an invoice in your Chargeback account. Use this endpoint when you need to add line items to existing invoices from your data sources.

• Enter the ID of the invoice to which you want to add a line item in the Invoice Id field. This is the unique identifier of the invoice that will receive the line item.

• The endpoint uses POST requests to {base_url}/invoices/{invoice_id}/add_line_item where {base_url} is your Chargeback environment base URL from the credential configuration and {invoice_id} is the invoice ID you provide. The endpoint URL is automatically constructed based on your credential's base URL configuration and the invoice ID.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the line item data to add. The request body should follow the Chargeback API specification for adding line items, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to add a line item to the invoice.

Invoice IDs can be obtained from the "List resources" data source endpoint by selecting "invoices" as the resource type, which returns all invoices with their corresponding IDs. The request body must be properly formatted JSON that matches the Chargeback API specification for adding line items. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about adding line items to invoices, including required fields, field names, and request formats, see the Chargeback API documentation.

Manual configuration

Chargeback destinations can also be manually configured to send data to any valid Chargeback API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, and request body.

The Chargeback API primarily uses POST requests for data writing operations, typically with JSON request bodies. Chargeback API endpoints typically follow the pattern {base_url}/{endpoint_path}, where {base_url} is your Chargeback environment base URL from the credential configuration. Basic Authentication and the Content-Type: application/json header are handled automatically by your credential configuration.

Save & activate

Once all endpoint settings have been configured, click the Save button to save and create the destination. To send the data to the configured Chargeback endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Chargeback endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.