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.

Path parameters

entrystringRequired<=50 characters

The entrypoint identifier.

Headers

requestTokenstringRequired

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

isSuccessbooleanOptional

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

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

responseCodeintegerOptional

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

responseDataobjectOptional

The response data containing the result of the import operation.

responseTextstringOptional

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

Errors