Import Entities

This guide explains how to import customers and vendors with the Payabli API.

​

Example CSV files

Before you get started, copy these CSV files and open them with the editor of your choice. Use these an example to help you build your import file.

​

Build the request

First, choose an endpoint. If you’re testing, use the Sandbox endpoint.. Make sure you use the right token for your selected environment. These endpoints accept POST requests only.

​

Authenticate

Authenticate by sending your API token in the request header with the key requestToken:
--header 'requestToken: API TOKEN'

​

Path parameter

The import endpoints have one required path parameter.

​

Query parameter (customers only)

When importing customers, there is an optional query parameter when importing customers.

​

Body parameter

The import endpoints have one required body parameter: a CSV file with the data you want to import.

​

Example request

Each tab has a request example for importing either customers or vendors for the entrypoint e56ce00572.

​

Example response

A successful request returns a JSON response with the number of added and rejected records, and any errors. The imported data is now available for use, and you can confirm by checking PartnerHub or PayHub.

{
  "isSuccess": true,
  "responseText": "Success",
  "responseCode": 1,
  "responseData": {
    "added": 98,
    "rejected": 0,
    "errors": []
  },
  "pageidentifier": null
}