Skip to main content

Chargeback Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a sync or streaming data flow that sends data to a Chargeback location.
chargeback_api.png

Chargeback

Create a Chargeback Destination​

  1. Click the + icon on the Nexset that will be sent to the Chargeback destination, and select the Send to Destination option from the menu.

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

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

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

Configure Using a Template​

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.

  • To configure this destination using a template, 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.

Configure Manually​

Chargeback destinations can be manually configured to send data to 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.

Using manual configuration, you can also configure Nexla to automatically send the response received from the Chargeback API after each call to a new Nexla webhook data source.

API Method​

  1. To manually configure this destination, 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 Chargeback API primarily uses POST requests for data writing operations. The most common methods are:

    • POST: For creating new resources or performing actions (e.g., creating resources, adding line items)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

Data Format​

  1. Select the format in which the Nexset data will be sent to the Chargeback API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Chargeback API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Chargeback API endpoint to which you want to send the Nexset data in the 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.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization (Basic Auth), Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. The Chargeback API requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Request Body​

Optional

  • If the API endpoint requires a specific request body format, configure how Nexla should format the request body from your Nexset data. The request body can be sent as JSON, XML, or form data, depending on the API endpoint requirements.

    • For JSON format, select JSON from the Request Body Format dropdown, and the Nexset data will be sent as a JSON object in the request body. Chargeback API endpoints typically use JSON format for request bodies.

    • For XML format, select XML from the Request Body Format dropdown, and the Nexset data will be converted to XML format in the request body.

    • For Form data format, select Form Data from the Request Body Format dropdown, and the Nexset data will be sent as form-encoded data in the request body.

Save the Destination​

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

  2. The destination will now be available in your data flow and will begin sending data to the Chargeback endpoint according to the configured settings.