GET
/
Customer
/
{customerId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Customer/{customerId} \
  --header 'requestToken: <api-key>'
{
  "customerId": 4440,
  "customerNumber": "3456-7645A",
  "customerUsername": "myusername",
  "customerStatus": 1,
  "Company": "AA LLC",
  "Firstname": "John",
  "Lastname": "Smith",
  "Phone": "1234567890",
  "Email": "example@email.com",
  "Address": "3245 Main St",
  "Address1": "STE 900",
  "City": "Miami",
  "State": "FL",
  "Zip": "77777",
  "Country": "US",
  "ShippingAddress": "123 Walnut St",
  "ShippingAddress1": "STE 900",
  "ShippingCity": "Johnson City",
  "ShippingState": "TN",
  "ShippingZip": "37619",
  "ShippingCountry": "US",
  "Balance": 123,
  "TimeZone": -5,
  "MFA": false,
  "MFAMode": 0,
  "snProvider": "facebook",
  "snIdentifier": "6677fgttyudd999",
  "snData": "",
  "LastUpdated": "2021-06-16T05:00:00",
  "Created": "2021-06-10T05:00:00",
  "AdditionalFields": {
    "property1": "string",
    "property2": "string"
  },
  "IdentifierFields": [
    "email"
  ],
  "Subscriptions": [
    {
      "IdSub": 396,
      "Method": "card",
      "PaypointId": 255,
      "TotalAmount": 103,
      "NetAmount": 3762.87,
      "FeeAmount": 3,
      "PaymentData": {
        "MaskedAccount": "4XXXXXXXX1111",
        "AccountType": "visa",
        "AccountExp": "11/29",
        "AccountZip": "90210",
        "HolderName": "Chad Mercia",
        "orderDescription": "Depost for materials for 123 Walnut St",
        "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
        "Initiator": "payor",
        "StoredMethodUsageType": "subscription",
        "Sequence": "subsequent",
        "accountId": "<string>",
        "SignatureData": null,
        "binData": {
          "binMatchedLength": 6,
          "binCardBrand": "Visa",
          "binCardType": "Credit",
          "binCardCategory": "PLATINUM",
          "binCardIssuer": "Bank of Example",
          "binCardIssuerCountry": "United States",
          "binCardIssuerCountryCodeA2": "US",
          "binCardIssuerCountryNumber": 840
        },
        "paymentDetails": {
          "totalAmount": 100,
          "serviceFee": 0,
          "currency": "USD",
          "checkNumber": "107",
          "checkImage": {},
          "categories": [
            {
              "label": "Deposit",
              "description": "Deposit for materials",
              "amount": 1000,
              "qty": 1
            }
          ],
          "splitFunding": [
            {
              "recipientEntryPoint": "41035afaa7",
              "accountId": "187-782",
              "description": "Split for annual dues",
              "amount": 456.23
            }
          ]
        }
      },
      "StartDate": "2025-10-19T00:00:00",
      "EndDate": "2025-10-19T00:00:00",
      "NextDate": "2025-10-19T00:00:00",
      "Frequency": "monthly",
      "TotalCycles": 24,
      "LeftCycles": 15,
      "LastRun": "2025-10-19T00:00:00",
      "SubStatus": 1,
      "EntrypageId": 0,
      "PlanId": 0,
      "UntilCancelled": true,
      "SubEvents": [
        {
          "description": "TransferCreated",
          "eventTime": "2023-07-05T22:31:06.8317486+00:00",
          "refData": "<string>",
          "extraData": {},
          "source": "api"
        }
      ],
      "LastUpdated": "2022-07-01 15:00:01",
      "Customer": {
        "CustomerId": 4440,
        "FirstName": "John",
        "LastName": "Doe",
        "CompanyName": "Sunshine LLC",
        "CustomerNumber": "3456-7645A",
        "BillingAddress1": "1111 West 1st Street",
        "BillingAddress2": "Suite 200",
        "BillingCity": "Miami",
        "BillingState": "FL",
        "BillingZip": "45567",
        "BillingCountry": "US",
        "BillingPhone": "5555555555",
        "BillingEmail": "example@email.com",
        "ShippingAddress1": "123 Walnut St",
        "ShippingAddress2": "STE 900",
        "ShippingCity": "Johnson City",
        "ShippingState": "TN",
        "ShippingZip": "37619",
        "ShippingCountry": "US",
        "AdditionalData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        },
        "CreatedAt": "2022-07-01 15:00:01",
        "customerId": 4440,
        "customerStatus": 1,
        "Identifiers": [
          "\\\"firstname\\\"",
          "\\\"lastname\\\"",
          "\\\"email\\\"",
          "\\\"customId\\\""
        ]
      },
      "InvoiceData": {
        "invoiceNumber": "INV-2345",
        "invoiceDate": "2024-07-01",
        "invoiceDueDate": "2024-07-01",
        "invoiceType": 0,
        "invoiceEndDate": "2024-07-01",
        "invoiceStatus": 1,
        "frequency": "monthly",
        "paymentTerms": "PIA",
        "termsConditions": "Must be paid before work scheduled.",
        "notes": "Example notes.",
        "tax": 2.05,
        "discount": 10,
        "invoiceAmount": 105,
        "freightAmount": 10,
        "dutyAmount": 0,
        "purchaseOrder": "PO-345",
        "firstName": "Chad",
        "lastName": "Mercia",
        "company": "ACME, INC",
        "shippingAddress1": "123 Walnut St",
        "shippingAddress2": "STE 900",
        "shippingCity": "Johnson City",
        "shippingState": "TN",
        "shippingZip": "37619",
        "shippingCountry": "US",
        "shippingEmail": "example@email.com",
        "shippingPhone": "5555555555",
        "shippingFromZip": "30040",
        "summaryCommodityCode": "501718",
        "items": [
          {
            "itemProductCode": "M-DEPOSIT",
            "itemProductName": "Materials deposit",
            "itemDescription": "Deposit for materials.",
            "itemCommodityCode": "010",
            "itemUnitOfMeasure": "SqFt",
            "itemCost": 5,
            "itemQty": 1,
            "itemMode": 0,
            "itemCategories": [
              "<string>"
            ],
            "itemTotalAmount": 123,
            "itemTaxAmount": 7,
            "itemTaxRate": 0.075
          }
        ],
        "attachments": {},
        "AdditionalData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        }
      },
      "PaypointLegalname": "Sunshine Services, LLC",
      "PaypointDbaname": "Sunshine Gutters",
      "PaypointEntryname": "d193cf9a46",
      "ParentOrgName": "PropertyManager Pro",
      "CreatedAt": "2022-07-01 15:00:01",
      "ExternalPaypointID": "Paypoint-100",
      "Source": "api"
    }
  ],
  "StoredMethods": [
    {
      "idPmethod": "6edcbb56-9c0e-4003-b3d1-99abf149ba0e",
      "method": "card",
      "descriptor": "visa",
      "maskedAccount": "4XXXXXXXX1111",
      "expDate": "1227",
      "holderName": "Chad Mercia",
      "bin": "411111",
      "binData": {
        "binMatchedLength": 6,
        "binCardBrand": "Visa",
        "binCardType": "Credit",
        "binCardCategory": "PLATINUM",
        "binCardIssuer": "Bank of Example",
        "binCardIssuerCountry": "United States",
        "binCardIssuerCountryCodeA2": "US",
        "binCardIssuerCountryNumber": 840
      },
      "lastUpdated": "2022-07-01 15:00:01"
    }
  ],
  "customerSummary": {
    "numberofTransactions": 30,
    "totalAmountTransactions": 1500,
    "totalNetAmountTransactions": 1500,
    "recentTransactions": [
      {
        "ParentOrgName": "PropertyManager Pro",
        "PaypointDbaname": "Sunshine Gutters",
        "PaypointLegalname": "Sunshine Services, LLC",
        "PaypointEntryname": "d193cf9a46",
        "PaymentTransId": "226-fe55ec0348e34702bd91b4be198ce7ec",
        "ConnectorName": "gp",
        "ExternalProcessorInformation": "[MER_xxxxxxxxxxxxxx]/[NNNNNNNNN]",
        "GatewayTransId": "TRN_xwCAjQorWAYX1nAhAoHZVfN8iYHbI0",
        "OrderId": "O-5140",
        "Method": "ach",
        "BatchNumber": "batch_226_ach_12-30-2023",
        "BatchAmount": 30.22,
        "PayorId": 1551,
        "PaymentData": {
          "MaskedAccount": "4XXXXXXXX1111",
          "AccountType": "visa",
          "AccountExp": "11/29",
          "AccountZip": "90210",
          "HolderName": "Chad Mercia",
          "orderDescription": "Depost for materials for 123 Walnut St",
          "StoredId": "1ec55af9-7b5a-4ff0-81ed-c12d2f95e135-4440",
          "Initiator": "payor",
          "StoredMethodUsageType": "subscription",
          "Sequence": "subsequent",
          "accountId": "<string>",
          "SignatureData": null,
          "binData": {
            "binMatchedLength": 6,
            "binCardBrand": "Visa",
            "binCardType": "Credit",
            "binCardCategory": "PLATINUM",
            "binCardIssuer": "Bank of Example",
            "binCardIssuerCountry": "United States",
            "binCardIssuerCountryCodeA2": "US",
            "binCardIssuerCountryNumber": 840
          },
          "paymentDetails": {
            "totalAmount": 100,
            "serviceFee": 0,
            "currency": "USD",
            "checkNumber": "107",
            "checkImage": {},
            "categories": [
              {
                "label": "Deposit",
                "description": "Deposit for materials",
                "amount": 1000,
                "qty": 1
              }
            ],
            "splitFunding": [
              {
                "recipientEntryPoint": "41035afaa7",
                "accountId": "187-782",
                "description": "Split for annual dues",
                "amount": 456.23
              }
            ]
          }
        },
        "TransStatus": 1,
        "PaypointId": 226,
        "TotalAmount": 30.22,
        "NetAmount": 3762.87,
        "FeeAmount": 1,
        "SettlementStatus": 2,
        "Operation": "Sale",
        "ResponseData": {
          "response": "<string>",
          "responsetext": "CAPTURED",
          "authcode": null,
          "transactionid": "TRN_XXXXXGOa87juzW",
          "avsresponse": "<string>",
          "avsresponse_text": "<string>",
          "cvvresponse": "<string>",
          "cvvresponse_text": "<string>",
          "orderid": "O-5140",
          "type": "<string>",
          "response_code": "XXX",
          "response_code_text": "Transaction was approved.",
          "emv_auth_response_data": "<string>"
        },
        "Source": "api",
        "ScheduleReference": 0,
        "OrgId": 123,
        "RefundId": 0,
        "ReturnedId": 0,
        "TransAdditionalData": "<any>",
        "InvoiceData": {
          "invoiceNumber": "INV-2345",
          "invoiceDate": "2024-07-01",
          "invoiceDueDate": "2024-07-01",
          "invoiceType": 0,
          "invoiceEndDate": "2024-07-01",
          "invoiceStatus": 1,
          "frequency": "monthly",
          "paymentTerms": "PIA",
          "termsConditions": "Must be paid before work scheduled.",
          "notes": "Example notes.",
          "tax": 2.05,
          "discount": 10,
          "invoiceAmount": 105,
          "freightAmount": 10,
          "dutyAmount": 0,
          "purchaseOrder": "PO-345",
          "firstName": "Chad",
          "lastName": "Mercia",
          "company": "ACME, INC",
          "shippingAddress1": "123 Walnut St",
          "shippingAddress2": "STE 900",
          "shippingCity": "Johnson City",
          "shippingState": "TN",
          "shippingZip": "37619",
          "shippingCountry": "US",
          "shippingEmail": "example@email.com",
          "shippingPhone": "5555555555",
          "shippingFromZip": "30040",
          "summaryCommodityCode": "501718",
          "items": [
            {
              "itemProductCode": "M-DEPOSIT",
              "itemProductName": "Materials deposit",
              "itemDescription": "Deposit for materials.",
              "itemCommodityCode": "010",
              "itemUnitOfMeasure": "SqFt",
              "itemCost": 5,
              "itemQty": 1,
              "itemMode": 0,
              "itemCategories": [
                "<string>"
              ],
              "itemTotalAmount": 123,
              "itemTaxAmount": 7,
              "itemTaxRate": 0.075
            }
          ],
          "attachments": {},
          "AdditionalData": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3"
          }
        },
        "EntrypageId": 0,
        "TransactionTime": "2025-10-19T00:00:00",
        "Customer": {
          "CustomerId": 4440,
          "FirstName": "John",
          "LastName": "Doe",
          "CompanyName": "Sunshine LLC",
          "CustomerNumber": "3456-7645A",
          "BillingAddress1": "1111 West 1st Street",
          "BillingAddress2": "Suite 200",
          "BillingCity": "Miami",
          "BillingState": "FL",
          "BillingZip": "45567",
          "BillingCountry": "US",
          "BillingPhone": "5555555555",
          "BillingEmail": "example@email.com",
          "ShippingAddress1": "123 Walnut St",
          "ShippingAddress2": "STE 900",
          "ShippingCity": "Johnson City",
          "ShippingState": "TN",
          "ShippingZip": "37619",
          "ShippingCountry": "US",
          "AdditionalData": {
            "key1": "value1",
            "key2": "value2",
            "key3": "value3"
          },
          "CreatedAt": "2022-07-01 15:00:01",
          "customerId": 4440,
          "customerStatus": 1,
          "Identifiers": [
            "\\\"firstname\\\"",
            "\\\"lastname\\\"",
            "\\\"email\\\"",
            "\\\"customId\\\""
          ]
        },
        "CfeeTransactions": [
          {
            "cFeeTransid": "<string>",
            "transStatus": 123,
            "feeAmount": 123,
            "settlementStatus": 123,
            "operation": "<string>",
            "responseData": {},
            "refundId": 123,
            "transactionTime": "\"2025-01-16T01:06:40.97\""
          }
        ],
        "splitFundingInstructions": [
          {
            "recipientEntryPoint": "41035afaa7",
            "accountId": "187-782",
            "description": "Split for annual dues",
            "amount": 456.23
          }
        ],
        "TransactionEvents": [
          {
            "TransEvent": "Approved",
            "EventData": {},
            "EventTime": "2023-11-07T05:31:56Z"
          }
        ],
        "PendingFeeAmount": 2,
        "DeviceId": "6c361c7d-674c-44cc-b790-382b75d1xxx",
        "AchSecCode": "<string>",
        "AchHolderType": "personal"
      }
    ]
  },
  "PaypointLegalname": "Sunshine Services, LLC",
  "PaypointDbaname": "Sunshine Gutters",
  "ParentOrgName": "PropertyManager Pro",
  "PaypointEntryname": "d193cf9a46",
  "pageidentifier": "null",
  "externalPaypointID": "Paypoint-100",
  "customerConsent": {
    "eCommunication": {
      "status": 1,
      "updatedAt": "2022-07-01 15:00:01"
    },
    "sms": {
      "status": 1,
      "updatedAt": "2022-07-01 15:00:01"
    }
  }
}

Authorizations

​
requestToken
string
header
required

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

Path Parameters

​
customerId
integer
required

Payabli-generated customer ID. Maps to "Customer ID" column in PartnerHub.

Example:

998

Response

200 - application/json
Success
​
customerId
integer | null

The Payabli-generated unique ID for the customer.

Example:

4440

​
customerNumber
string | null

User-provided unique identifier for the customer. This is typically the customer ID from your own system.

Maximum length: 250
Example:

"3456-7645A"

​
customerUsername
string | null

Username for customer.

Example:

"myusername"

​
customerStatus
integer | null

Customer Status. Possible values:

  • -99 Deleted
  • 0 Inactive
  • 1 Active
  • 85 Locked (typically due to multiple failed login attempts)
Example:

1

​
Company
string | null

Company name.

Example:

"AA LLC"

​
Firstname
string | null

Customer first name.

Example:

"John"

​
Lastname
string | null

Customer last name.

Example:

"Smith"

​
Phone
string | null

Customer phone number.

Example:

"1234567890"

​
Email
string | null

Customer email address.

Maximum length: 320
Example:

"example@email.com"

​
Address
string | null

Customer address.

Example:

"3245 Main St"

​
Address1
string | null

Additional line for customer address.

Example:

"STE 900"

​
City
string | null

Customer city.

Example:

"Miami"

​
State
string | null

Customer state.

Example:

"FL"

​
Zip
string | null

Customer zip code.

Example:

"77777"

​
Country
string | null

Customer country.

Example:

"US"

​
ShippingAddress
string | null

The shipping address.

Maximum length: 250
Example:

"123 Walnut St"

​
ShippingAddress1
string | null

Additional line for shipping address.

Maximum length: 100
Example:

"STE 900"

​
ShippingCity
string | null

Shipping city.

Maximum length: 250
Example:

"Johnson City"

​
ShippingState
string | null

Shipping state or province.

Example:

"TN"

​
ShippingZip
string | null

Shipping ZIP code.

Maximum length: 50
Example:

"37619"

​
ShippingCountry
string | null

Shipping address country.

Example:

"US"

​
Balance
number | null

Customer balance.

​
TimeZone
integer | null
default:0

Timezone, in UTC offset. For example, -5 is Eastern time.

Example:

-5

​
MFA
boolean | null

When true, multi-factor authentication (MFA) is enabled.

Example:

false

​
MFAMode
integer
Example:

0

​
snProvider
string | null

Social network linked to customer.
Possible values:

  • facebook
  • google
  • twiter
  • microsoft
Example:

"facebook"

​
snIdentifier
string | null

Identifier or token for customer in linked social network.

Example:

"6677fgttyudd999"

​
snData
string | null

Additional data provided by the social network related to the customer.

Example:

""

​
LastUpdated
string | null

Date and time of last update.

Example:

"2021-06-16T05:00:00"

​
Created
string

Date and time created.

Example:

"2021-06-10T05:00:00"

​
AdditionalFields
object

List of additional custom fields in format key:value.

Example:
{
  "property1": "string",
  "property2": "string"
}
​
IdentifierFields
(string | null)[] | null

List of fields acting as customer identifiers, to be used instead of CustomerNumber.

Example:
["email"]
​
Subscriptions
object[] | null

List of subscriptions associated to the customer.

​
StoredMethods
object[] | null

List of payment methods associated to the customer.

​
customerSummary
object
​
PaypointLegalname
string | null

Paypoint legal name.

Example:

"Sunshine Services, LLC"

​
PaypointDbaname
string | null

Paypoint DBA name.

Example:

"Sunshine Gutters"

​
ParentOrgName
string | null

The name of the parent organization.

Example:

"PropertyManager Pro"

​
PaypointEntryname
string | null

The entrypoint identifier.

Maximum length: 50
Example:

"d193cf9a46"

​
pageidentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

​
externalPaypointID
string | null

A custom identifier for the paypoint, if applicable. Like entrypoint is the Payabli identifier for the merchant, externalPaypointId is a custom field you can use to include the merchant's ID from your own systems.

Example:

"Paypoint-100"

​
customerConsent
object

Was this page helpful?

Add CustomerUpdate Customer