Upload a customers sheet for review
curl -X POST "https://test-api.kashier.io/v2/customers/import" \ -F file="string"{ "customers": [ { "name": "John Doe", "phoneNumber": "1123456789", "emailAddress": "", "customFields": [ { "name": "custom-key-1", "value": "custom-value-1" }, { "name": "custom-key-2", "value": "custom-value-2" } ], "errors": null }, { "name": "Jane Doe", "phoneNumber": "1123456780", "emailAddress": "", "customFields": [ { "name": "custom-key-1", "value": "custom-value-2" } ], "errors": null } ], "correlationId": "48701e20-ffa2-4c33-be5e-fef3dbfaf94a", "message": "Imported successfully"}Step 1 of the bulk import. Uploads an Excel sheet of customers and validates it without saving anything. Rows that fail validation come back with their errors populated so you can correct them; if the sheet is valid the response carries a correlationId that references the validated data. Pass that correlationId to saveImportedCustomers to actually create the customers.
Authorization
secretKey Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).
In: header
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
Export customers with their payment links POST
Exports a chosen set of customers together with the payment links created for them. Pass customerIds to export specific customers, or the date/search filters to export everything that matches. Like…
Save the uploaded customers GET
Step 2 of the bulk import. Persists the customers that were validated by importCustomers, identified by the correlationId returned there. Separating validation from the write keeps a partially inva…