Skip to main content

Nexiopay

Nexiopay (Nexio) is a payment processing and payout platform that exposes RESTful APIs for terminal management, transaction handling, card tokenization, and recipient management. Use this connector to ingest payments, transactions, statements, and recipient data into Nexla, and to process, capture, refund, and manage payments and recipients from your Nexla flows.

Nexiopay icon

Power end-to-end data operations for your Nexiopay API with Nexla. Our bi-directional Nexiopay connector is purpose-built for Nexiopay, 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 Nexiopay or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Nexiopay 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 Nexiopay credential, you need a Nexio API username and its associated API key. Nexiopay authenticates API requests using HTTP Basic Authentication, where the username is your API user's username and the password is that user's API key.

To obtain your Nexiopay credentials, follow these steps:

  1. Sign in to your Nexio Dashboard using your administrator account.

  2. Navigate to Settings > User Management to view and manage your users.

  3. Locate the user you want to use for API access (or add a new user for the integration), and copy its username.

  4. Copy the API key for that user. This value is used as the password for Basic Authentication.

  5. Confirm the base URL for your environment. The production base URL is https://api.nexiopay.com.

Nexla base64-encodes the username and API key and sends them in the Authorization: Basic header on each request, so you only need to supply the raw username, API key, and base URL when creating the credential. Keep the API key confidential, and rotate it in User Management if it is ever exposed. For more detail, see the Nexio Authentication documentation.

Authenticate

Credentials required

HTTP Basic Authentication using username and password credentials for Nexiopay API access.

FieldRequiredSecretDescription
Username Or API KeyYesNoYour username or personal API Key
PasswordYesYesYour password
Base URLYesNoNexiopay API base URL endpoint Allowed values: Production

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.

  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 Nexio API user's username in the Username Or API Key field.

  4. Enter the API key for that user in the Password field. This value is treated as secret and is used as the password for Basic Authentication.

  5. Select or enter the Base URL for your Nexiopay environment. The production endpoint is https://api.nexiopay.com.

    Nexla combines the username and API key into an Authorization: Basic header for each request. Keep the API key confidential and rotate it from your Nexio Dashboard under Settings > User Management if it is ever exposed.

  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.

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 Nexiopay connector tile, then select the credential that will be used to connect to Nexiopay, and click Next; or, create a new Nexiopay 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 Nexiopay endpoints. 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.

[Rest API] List Terminals

Returns a list of all payment terminals associated with the account.

Use this endpoint to ingest terminal records for reporting or reconciliation. For details on the response structure, see the Nexio API documentation.

[Rest API] List Recipients

Returns a list of all payout recipients configured in the account.

This endpoint is paginated using offset-based paging; Nexla automatically requests subsequent pages until no further records are returned. For details on the response structure, see the Nexio API documentation.

[Rest API] List Payment Types

Returns a list of all available payment types supported by the account.

Use this endpoint to ingest the set of payment types enabled for your account. For details on the response structure, see the Nexio API documentation.

[Rest API] Get Current User

Returns information about the currently authenticated user account.

This endpoint returns details about the account associated with your credential and is useful for verifying that authentication is configured correctly. For details on the response structure, see the Nexio API documentation.

[Rest API] List Spendbacks

Returns a list of all spendback transactions in the account.

This endpoint is paginated using offset-based paging; Nexla automatically requests subsequent pages until no further records are returned. For details on the response structure, see the Nexio API documentation.

[Rest API] List Card Tokens

Returns a list of all card tokens stored in the account.

This endpoint is paginated using offset-based paging; Nexla automatically requests subsequent pages until no further records are returned. For details on the response structure, see the Nexio API documentation.

[Rest API] List Transactions

Returns all transactions matching specified filter criteria for the authenticated Nexio account, with offset-based pagination.

This endpoint is paginated using offset-based paging; Nexla automatically requests subsequent pages until no further records are returned. For details on the response structure, see the Nexio View Transactions documentation.

[Rest API] List Adjustments

Returns all adjustments within a given date range for all merchant IDs associated with the account.

This endpoint is paginated using offset-based paging; Nexla automatically requests subsequent pages until no further records are returned. For details on the response structure, see the Nexio View Adjustments documentation.

[Rest API] List Statements

Returns all statements within a given date range for all merchant IDs associated with the account.

This endpoint is paginated using offset-based paging; Nexla automatically requests subsequent pages until no further records are returned. For details on the response structure, see the Nexio View Statements 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

Nexiopay data sources can also be manually configured to ingest data from any valid Nexiopay 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, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Nexiopay data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Nexiopay destination, and select the Send to Destination option from the menu. Select the Nexiopay connector from the list of available destination connectors, then select the credential that will be used to connect to Nexiopay, and click Next; or, create a new Nexiopay 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 Nexiopay endpoints. 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.

[Rest API] Process Card Transaction

Processes a card payment transaction using a saved card token.

Each record from your Nexset is sent as JSON in the request body to process a card transaction. The record must match the format expected by the Nexio API. For details, see the Running a card transaction with the API documentation.

[Rest API] Create Recipient

Creates a new payout recipient in the account.

Each record from your Nexset is sent as JSON in the request body to create a payout recipient. The record must match the format expected by the Nexio API. For details on the recipient object, see the Nexio API documentation.

[Rest API] Update Recipient

Updates an existing payout recipient record.

  • This endpoint requires a Recipient ID parameter — the unique identifier of the recipient to update — which is appended to the request URL.

Each record from your Nexset is sent as JSON in the request body to update the specified recipient. The record must match the format expected by the Nexio API. For details on the recipient object, see the Nexio API documentation.

[Rest API] Delete Card Token

Deletes a saved card token from the account.

  • This endpoint requires a Card Token parameter — the card token to delete — which is appended to the request URL.

This endpoint issues a delete request against the specified card token. For details, see the Nexio API documentation.

[Rest API] Refund Transaction

Refunds a previously captured card transaction by Nexio payment ID and amount.

Each record from your Nexset is sent as JSON in the request body to refund a captured transaction. The record must include the Nexio payment ID and amount as expected by the Nexio API. For details, see the Refund Transaction documentation.

[Rest API] Capture Transaction

Captures a previously authorized (auth-only) card transaction by Nexio payment ID.

Each record from your Nexset is sent as JSON in the request body to capture an authorized transaction. The record must include the Nexio payment ID as expected by the Nexio API. For details, see the Capture Transaction documentation.

[Rest API] Capture APM Transaction

Captures a previously authorized APM (alternative payment method) transaction.

Each record from your Nexset is sent as JSON in the request body to capture an authorized alternative payment method transaction. The record must match the format expected by the Nexio API. For details, see the Capture APM Transaction documentation.

[Rest API] Create User

Creates a new user account with a specified role (View-Only, Standard, or Admin).

Each record from your Nexset is sent as JSON in the request body to create a user account with the specified role. The record must match the format expected by the Nexio API. For details, see the Create User documentation.

Manual configuration

Nexiopay destinations can also be manually configured to send data to any valid Nexiopay 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, attribute exclusions, record batching, and response webhooks.

Nexiopay APIs expect JSON in the request body for most write operations. For update and delete operations, include the identifier of the object to be modified at the end of the URL.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Nexiopay endpoint, open the destination resource menu, and select Activate.

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