POST
/
Customer
/
single
/
{entry}
curl --request POST \
  --url https://api-sandbox.payabli.com/api/Customer/single/{entry} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "customerNumber": "3456-7645A",
  "customerUsername": "myusername",
  "customerPsw": "mypassword",
  "customerStatus": 1,
  "company": "Sunshine LLC",
  "firstname": "John",
  "lastname": "Smith",
  "phone": "1234567890",
  "email": "example@email.com",
  "address": "777 Main St",
  "address1": "Apt 6",
  "city": "Miami",
  "state": "FL",
  "zip": "33000",
  "country": "US",
  "shippingAddress": "123 Walnut St",
  "shippingAddress1": "STE 900",
  "shippingCity": "Johnson City",
  "shippingState": "TN",
  "shippingZip": "37619",
  "shippingCountry": "US",
  "balance": 988.44,
  "timeZone": -5,
  "additionalFields": {},
  "identifierFields": [
    "email"
  ],
  "createdAt": "2022-07-01 15:00:01"
}'
{
  "responseText": "Success",
  "responseData": {
    "customerId": 17264,
    "customerNumber": "12356ACB",
    "customerUsername": null,
    "customerStatus": 0,
    "Company": null,
    "Firstname": "Irene",
    "Lastname": "Canizales",
    "Phone": null,
    "Email": "irene@canizalesconcrete.com",
    "Address": null,
    "Address1": "123 Bishop's Trail",
    "City": "Mountain City",
    "State": "TN",
    "Zip": "37612",
    "Country": "US",
    "ShippingAddress": null,
    "ShippingAddress1": null,
    "ShippingCity": null,
    "ShippingState": null,
    "ShippingZip": null,
    "ShippingCountry": null,
    "Balance": 0,
    "TimeZone": -5,
    "MFA": false,
    "MFAMode": 0,
    "snProvider": null,
    "snIdentifier": null,
    "snData": null,
    "LastUpdated": "2024-03-13T12:49:56.5455717+00:00",
    "Created": "2024-03-13T12:49:56.5455717+00:00",
    "AdditionalFields": {},
    "IdentifierFields": [
      "email"
    ],
    "Subscriptions": null,
    "StoredMethods": null,
    "customerSummary": {
      "NumberofTransactions": 0,
      "TotalAmountTransactions": 0,
      "TotalNetAmountTransactions": 0,
      "RecentTransactions": null
    },
    "PaypointLegalname": "Gruzya Adventure Outfitters, LLC",
    "PaypointDbaname": "Gruzya Adventure Outfitters",
    "ParentOrgName": "The Pilgrim Planner",
    "PaypointEntryname": "41035afaa7",
    "pageindentifier": null,
    "externalPaypointID": null
  },
  "pageIdentifier": null,
  "isSuccess": true
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Headers

​
idempotencyKey
string

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Example:

"6B29FC40-CA47-1067-B31D-00DD010662DA"

Path Parameters

​
entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

Query Parameters

​
replaceExisting
integer
default:0

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

​
forceCustomerCreation
boolean
default:false

When true, the request creates a new customer record, regardless of whether customer identifiers match an existing customer.

Body

CustomerData object to add.

Data pertaining to single customer. See customerData Object Model for a complete reference.

Response

200 - application/json

Success

The response is of type object.