Skip to main content

Data Source

Follow the instructions below to create a new data flow that ingests data from a Chargeback source in Nexla.
chargeback_api.png

Chargeback

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. 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.

  3. In Nexla, Chargeback data sources can be created using pre-built endpoint templates, which expedite source setup for common Chargeback endpoints. Each template is designed specifically for the corresponding Chargeback endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Chargeback sources can also be configured manually, allowing you to ingest data from Chargeback endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

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.

Endpoint Settings​

  • 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    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.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Chargeback data sources can be manually configured to ingest data from any valid Chargeback API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Chargeback sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom authentication headers or request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Chargeback API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Chargeback API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Chargeback API endpoints typically follow the pattern {base_url}/{endpoint_path} where {base_url} is your Chargeback environment base URL.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. For detailed information about Chargeback API endpoints and available APIs, see the Chargeback API documentation.

Path to Data​

  1. Enter the JSON path that identifies the location of the relevant data within the API response in the Path to Data field. JSON paths use dot notation to navigate through nested JSON structures.

    • For example, if your API response has the structure {"data": [...]}, you would enter $.data[*] to extract all items from the data array.
    • Use $[*] to extract all items from a root-level array.
    • Use $ to extract the entire root-level object.

JSON paths are case-sensitive and must match the exact structure of your API response. Chargeback API responses typically use a data array to contain the actual data. Use the Test button to verify that your JSON path correctly extracts the desired data from the API response.

Save the Data Source​

  1. Once all configuration steps have been completed, click the Save button to save your data source configuration.

  2. The data source will now be available in your data flow and will begin ingesting data according to the configured schedule and endpoint settings.