API referencePay In endpointsCustomer

Import customers

Import a list of customers from a CSV file. See the Import Guide for more help and example files.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

entrystringRequired<=50 characters
The entrypoint identifier.

Query parameters

replaceExistingintegerOptional<=1Defaults to 0

Flag indicating to replace existing customer with a new record. Possible values: 0 (do not replace), 1 (replace). Default is 0

Request

This endpoint expects a multipart form containing a file.
filefileRequired

Response

Success
isSuccessboolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstring
Auxiliary validation used internally by payment pages and components.
responseCodeinteger

Code for the response. Learn more in API Response Codes.

responseDataobject
The response data containing the result of the import operation.
responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error