GET Api/Customer?customerToken={customerToken}
Searches for an existing enrolled customer in the system
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| customerToken |
Contains the token that uniquely identifies this customer in the system. The customerToken value must be URL encoded. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
Searches for an existing enrolled customer in the system
APICustomerResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode |
Name of the error condition. See ErrorCode model for details. |
ErrorCode |
None. |
| ErrorCodeDetail |
Detailed error condition code. |
string |
None. |
| ErrorID |
Internal error identification number that uniquely identifies this specific error that occurred. |
string |
None. |
| ErrorNum |
Numeric value of the ErrorCode |
int |
None. |
| Errors |
List of errors that occurred when performing the customer operation. |
Collection of string |
None. |
| Result |
On success contains the requested Customer object model. See CustomerResponseModel for details. |
CustomerResponseModel |
None. |
| Success |
Indicates sucess or failure of the REST request. |
boolean |
None. |
| WarningCode |
Name of the warning condition. See WarningCode model for details. |
WarningCode |
None. |
| Warnings |
List of warnings that occurred when performing the customer operation. |
Collection of string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ErrorCode": "None",
"ErrorCodeDetail": "sample string 1",
"ErrorID": "sample string 2",
"ErrorNum": 0,
"Errors": [
"sample string 1",
"sample string 2"
],
"WarningCode": "None",
"Warnings": [
"sample string 1",
"sample string 2"
],
"Result": {
"AllBillingAccounts": [
{
"AccountStatusType": "Active",
"Address": "sample string 2",
"CustomersWithAccess": [
{
"CustomerID": 1,
"Email": "sample string 2",
"Name": "sample string 3",
"Status": 4
},
{
"CustomerID": 1,
"Email": "sample string 2",
"Name": "sample string 3",
"Status": 4
}
],
"Default": true,
"Description": "sample string 6",
"HasAutoDebit": true,
"HasCustomers": true,
"IsAddOnAccount": true,
"IsPrincipal": true,
"LinkStatus": "Principal",
"Name": "sample string 11",
"OtherData": "sample string 12",
"Owner": "sample string 13",
"ReferenceNumber": "sample string 14",
"AlternativeReferenceNumbers": [
"sample string 1",
"sample string 2"
],
"Statuses": [
{
"AccountStatusType": "Active",
"Code": "sample string 1",
"Description": "sample string 2",
"ID": 3,
"Name": "sample string 4"
},
{
"AccountStatusType": "Active",
"Code": "sample string 1",
"Description": "sample string 2",
"ID": 3,
"Name": "sample string 4"
}
],
"Stopped": true,
"ProductCode": "CreditCard",
"WaiveFee": true
},
{
"AccountStatusType": "Active",
"Address": "sample string 2",
"CustomersWithAccess": [
{
"CustomerID": 1,
"Email": "sample string 2",
"Name": "sample string 3",
"Status": 4
},
{
"CustomerID": 1,
"Email": "sample string 2",
"Name": "sample string 3",
"Status": 4
}
],
"Default": true,
"Description": "sample string 6",
"HasAutoDebit": true,
"HasCustomers": true,
"IsAddOnAccount": true,
"IsPrincipal": true,
"LinkStatus": "Principal",
"Name": "sample string 11",
"OtherData": "sample string 12",
"Owner": "sample string 13",
"ReferenceNumber": "sample string 14",
"AlternativeReferenceNumbers": [
"sample string 1",
"sample string 2"
],
"Statuses": [
{
"AccountStatusType": "Active",
"Code": "sample string 1",
"Description": "sample string 2",
"ID": 3,
"Name": "sample string 4"
},
{
"AccountStatusType": "Active",
"Code": "sample string 1",
"Description": "sample string 2",
"ID": 3,
"Name": "sample string 4"
}
],
"Stopped": true,
"ProductCode": "CreditCard",
"WaiveFee": true
}
],
"BillerID": 1,
"BillingAccounts": [
{
"AccountStatusType": "Active",
"Address": "sample string 2",
"CustomersWithAccess": [
{
"CustomerID": 1,
"Email": "sample string 2",
"Name": "sample string 3",
"Status": 4
},
{
"CustomerID": 1,
"Email": "sample string 2",
"Name": "sample string 3",
"Status": 4
}
],
"Default": true,
"Description": "sample string 6",
"HasAutoDebit": true,
"HasCustomers": true,
"IsAddOnAccount": true,
"IsPrincipal": true,
"LinkStatus": "Principal",
"Name": "sample string 11",
"OtherData": "sample string 12",
"Owner": "sample string 13",
"ReferenceNumber": "sample string 14",
"AlternativeReferenceNumbers": [
"sample string 1",
"sample string 2"
],
"Statuses": [
{
"AccountStatusType": "Active",
"Code": "sample string 1",
"Description": "sample string 2",
"ID": 3,
"Name": "sample string 4"
},
{
"AccountStatusType": "Active",
"Code": "sample string 1",
"Description": "sample string 2",
"ID": 3,
"Name": "sample string 4"
}
],
"Stopped": true,
"ProductCode": "CreditCard",
"WaiveFee": true
},
{
"AccountStatusType": "Active",
"Address": "sample string 2",
"CustomersWithAccess": [
{
"CustomerID": 1,
"Email": "sample string 2",
"Name": "sample string 3",
"Status": 4
},
{
"CustomerID": 1,
"Email": "sample string 2",
"Name": "sample string 3",
"Status": 4
}
],
"Default": true,
"Description": "sample string 6",
"HasAutoDebit": true,
"HasCustomers": true,
"IsAddOnAccount": true,
"IsPrincipal": true,
"LinkStatus": "Principal",
"Name": "sample string 11",
"OtherData": "sample string 12",
"Owner": "sample string 13",
"ReferenceNumber": "sample string 14",
"AlternativeReferenceNumbers": [
"sample string 1",
"sample string 2"
],
"Statuses": [
{
"AccountStatusType": "Active",
"Code": "sample string 1",
"Description": "sample string 2",
"ID": 3,
"Name": "sample string 4"
},
{
"AccountStatusType": "Active",
"Code": "sample string 1",
"Description": "sample string 2",
"ID": 3,
"Name": "sample string 4"
}
],
"Stopped": true,
"ProductCode": "CreditCard",
"WaiveFee": true
}
],
"Customer": {
"AcceptedTermsOfService": true,
"Address": "sample string 1",
"Address2": "sample string 2",
"BillDue": "None",
"BillDueDays": 1,
"BillPastDue": "None",
"BillPastDueDays": 1,
"City": "sample string 3",
"CompanyName": "sample string 4",
"Country": "sample string 5",
"Email": "sample string 7",
"ConfirmEmail": "sample string 8",
"DisableBillNotification": true,
"Email2": "sample string 10",
"Email3": "sample string 11",
"ExternalUserID": "sample string 12",
"FirstName": "sample string 13",
"LastName": "sample string 14",
"MiddleName": "sample string 15",
"Phone": "sample string 16",
"MobilePhone": "sample string 17",
"PaperSuppression": true,
"SendPinacleRFP": true,
"State": "sample string 19",
"SMSEnrollOnlyRegistrationStatus": "NotRegistered",
"SMSEnrollOnlyMobile": "sample string 20",
"Zip": "sample string 22"
},
"CustomerStatus": "NotActivated",
"CustomerType": "Enrolled",
"CustomerToken": "sample string 2",
"DefaultPaymentAccount": 3,
"Deleted": true,
"DeniedAccountStatus": true,
"DisplayName": "sample string 6",
"dtCreate": "2025-11-03T15:53:01.8733008Z",
"dtUpdate": "2025-11-03T15:53:01.8733008Z",
"EnrollmentType": "None",
"ID": 7,
"IsEnrolled": true,
"IsLockedOut": true,
"IsRTPEnabled": true,
"LoginID": "sample string 11",
"MasterEntities": [
{
"OtherData": "sample string 2",
"ReferenceNumber": "sample string 3"
},
{
"OtherData": "sample string 2",
"ReferenceNumber": "sample string 3"
}
],
"PaymentAccounts": [
{
"Account": "Visa",
"AccountNumberLastFour": "1234",
"AchBankName": "sample string 1",
"AchRegion": "USA",
"Address": "sample string 2",
"Address2": "sample string 3",
"CcCardType": "Visa",
"CcChargeType": "Unknown",
"CcExpirationDate": "01/16",
"City": "sample string 5",
"Country": "USA",
"Description": "sample string 7",
"DisplayAccountNumber": "*****1234",
"DisplayDescription": "sample string 8",
"DisplayRoutingNumber": "*****0614",
"ExternalUserID": "sample string 10",
"FirstName": "sample string 11",
"IsAmazonPay": true,
"IsApplePay": true,
"IsBankAccount": true,
"IsBilledByAutoDebit": true,
"IsBilledByPaymentPlan": true,
"IsBilledByRecurringPayment": true,
"IsBlocked": true,
"IsBusinessAccount": true,
"IsCheckingAccount": true,
"IsCreditCard": true,
"IsPayPal": true,
"IsPersonalAccount": true,
"IsPinacleAccount": true,
"IsRTPAccount": true,
"IsRTPEligible": true,
"IsSavingsAccount": true,
"LastName": "sample string 29",
"Name": "sample string 30",
"PaymentAccountType": "ACH",
"State": "NY",
"Swiped": true,
"Token": "sample string 34",
"Validated": true,
"Zip": "sample string 35"
},
{
"Account": "Visa",
"AccountNumberLastFour": "1234",
"AchBankName": "sample string 1",
"AchRegion": "USA",
"Address": "sample string 2",
"Address2": "sample string 3",
"CcCardType": "Visa",
"CcChargeType": "Unknown",
"CcExpirationDate": "01/16",
"City": "sample string 5",
"Country": "USA",
"Description": "sample string 7",
"DisplayAccountNumber": "*****1234",
"DisplayDescription": "sample string 8",
"DisplayRoutingNumber": "*****0614",
"ExternalUserID": "sample string 10",
"FirstName": "sample string 11",
"IsAmazonPay": true,
"IsApplePay": true,
"IsBankAccount": true,
"IsBilledByAutoDebit": true,
"IsBilledByPaymentPlan": true,
"IsBilledByRecurringPayment": true,
"IsBlocked": true,
"IsBusinessAccount": true,
"IsCheckingAccount": true,
"IsCreditCard": true,
"IsPayPal": true,
"IsPersonalAccount": true,
"IsPinacleAccount": true,
"IsRTPAccount": true,
"IsRTPEligible": true,
"IsSavingsAccount": true,
"LastName": "sample string 29",
"Name": "sample string 30",
"PaymentAccountType": "ACH",
"State": "NY",
"Swiped": true,
"Token": "sample string 34",
"Validated": true,
"Zip": "sample string 35"
}
],
"PaymentPlans": [
{
"BillingAccounts": [
{
"AccountID": 1,
"AccountNumber": "sample string 2",
"AmountDue": 3.0,
"CurrencySymbol": "sample string 4",
"DueDate": "2025-11-03T15:53:01.8889561Z",
"ExistingPaymentPlanID": 1,
"PendingPayment": {
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
},
"PendingPayments": [
{
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
},
{
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
}
],
"RoleMaskedAccount": "sample string 5",
"Stopped": true,
"UpdateDate": "2025-11-03T15:53:01.8889561Z"
},
{
"AccountID": 1,
"AccountNumber": "sample string 2",
"AmountDue": 3.0,
"CurrencySymbol": "sample string 4",
"DueDate": "2025-11-03T15:53:01.8889561Z",
"ExistingPaymentPlanID": 1,
"PendingPayment": {
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
},
"PendingPayments": [
{
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
},
{
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
}
],
"RoleMaskedAccount": "sample string 5",
"Stopped": true,
"UpdateDate": "2025-11-03T15:53:01.8889561Z"
}
],
"CanEdit": true,
"CurrencySymbol": "sample string 2",
"CustomerID": 1,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"DayToPay": 4,
"DayType": "DayToPay",
"DisplayDescription": "sample string 5",
"InitialBalance": 6.0,
"LastEvaluatedDate": "2025-11-03T15:53:01.8889561Z",
"LastPaymentAmount": 7.0,
"LastPaymentDate": "2025-11-03T15:53:01.8889561Z",
"MonthlyAmount": 9.0,
"PaymentAccountID": 10,
"PaymentAccount": {
"Account": "Visa",
"AccountNumberLastFour": "1234",
"AchBankName": "sample string 1",
"AchRegion": "USA",
"Address": "sample string 2",
"Address2": "sample string 3",
"CcCardType": "Visa",
"CcChargeType": "Unknown",
"CcExpirationDate": "01/16",
"City": "sample string 5",
"Country": "USA",
"Description": "sample string 7",
"DisplayAccountNumber": "*****1234",
"DisplayDescription": "sample string 8",
"DisplayRoutingNumber": "*****0614",
"ExternalUserID": "sample string 10",
"FirstName": "sample string 11",
"IsAmazonPay": true,
"IsApplePay": true,
"IsBankAccount": true,
"IsBilledByAutoDebit": true,
"IsBilledByPaymentPlan": true,
"IsBilledByRecurringPayment": true,
"IsBlocked": true,
"IsBusinessAccount": true,
"IsCheckingAccount": true,
"IsCreditCard": true,
"IsPayPal": true,
"IsPersonalAccount": true,
"IsPinacleAccount": true,
"IsRTPAccount": true,
"IsRTPEligible": true,
"IsSavingsAccount": true,
"LastName": "sample string 29",
"Name": "sample string 30",
"PaymentAccountType": "ACH",
"State": "NY",
"Swiped": true,
"Token": "sample string 34",
"Validated": true,
"Zip": "sample string 35"
},
"PaymentAmount": 11.0,
"PaymentName": "sample string 12",
"PaymentPlanID": 13,
"Payments": [
{
"Amount": 1.0,
"PaymentDate": "2025-11-03T15:53:01.8889561Z",
"PaymentID": 1
},
{
"Amount": 1.0,
"PaymentDate": "2025-11-03T15:53:01.8889561Z",
"PaymentID": 1
}
],
"RemainingBalance": 14.0,
"PaymentCount": 15,
"PaymentPlanType": "Fixed",
"PPD": true,
"StartDate": "2025-11-03T15:53:01.904544Z",
"Status": "Active",
"Term": 18,
"UpdateDate": "2025-11-03T15:53:01.904544Z"
},
{
"BillingAccounts": [
{
"AccountID": 1,
"AccountNumber": "sample string 2",
"AmountDue": 3.0,
"CurrencySymbol": "sample string 4",
"DueDate": "2025-11-03T15:53:01.8889561Z",
"ExistingPaymentPlanID": 1,
"PendingPayment": {
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
},
"PendingPayments": [
{
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
},
{
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
}
],
"RoleMaskedAccount": "sample string 5",
"Stopped": true,
"UpdateDate": "2025-11-03T15:53:01.8889561Z"
},
{
"AccountID": 1,
"AccountNumber": "sample string 2",
"AmountDue": 3.0,
"CurrencySymbol": "sample string 4",
"DueDate": "2025-11-03T15:53:01.8889561Z",
"ExistingPaymentPlanID": 1,
"PendingPayment": {
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
},
"PendingPayments": [
{
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
},
{
"AccountTotal": 1.0,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"Status": "Initiated",
"Total": 3.0,
"TransactionID": 4
}
],
"RoleMaskedAccount": "sample string 5",
"Stopped": true,
"UpdateDate": "2025-11-03T15:53:01.8889561Z"
}
],
"CanEdit": true,
"CurrencySymbol": "sample string 2",
"CustomerID": 1,
"CreateDate": "2025-11-03T15:53:01.8889561Z",
"DayToPay": 4,
"DayType": "DayToPay",
"DisplayDescription": "sample string 5",
"InitialBalance": 6.0,
"LastEvaluatedDate": "2025-11-03T15:53:01.8889561Z",
"LastPaymentAmount": 7.0,
"LastPaymentDate": "2025-11-03T15:53:01.8889561Z",
"MonthlyAmount": 9.0,
"PaymentAccountID": 10,
"PaymentAccount": {
"Account": "Visa",
"AccountNumberLastFour": "1234",
"AchBankName": "sample string 1",
"AchRegion": "USA",
"Address": "sample string 2",
"Address2": "sample string 3",
"CcCardType": "Visa",
"CcChargeType": "Unknown",
"CcExpirationDate": "01/16",
"City": "sample string 5",
"Country": "USA",
"Description": "sample string 7",
"DisplayAccountNumber": "*****1234",
"DisplayDescription": "sample string 8",
"DisplayRoutingNumber": "*****0614",
"ExternalUserID": "sample string 10",
"FirstName": "sample string 11",
"IsAmazonPay": true,
"IsApplePay": true,
"IsBankAccount": true,
"IsBilledByAutoDebit": true,
"IsBilledByPaymentPlan": true,
"IsBilledByRecurringPayment": true,
"IsBlocked": true,
"IsBusinessAccount": true,
"IsCheckingAccount": true,
"IsCreditCard": true,
"IsPayPal": true,
"IsPersonalAccount": true,
"IsPinacleAccount": true,
"IsRTPAccount": true,
"IsRTPEligible": true,
"IsSavingsAccount": true,
"LastName": "sample string 29",
"Name": "sample string 30",
"PaymentAccountType": "ACH",
"State": "NY",
"Swiped": true,
"Token": "sample string 34",
"Validated": true,
"Zip": "sample string 35"
},
"PaymentAmount": 11.0,
"PaymentName": "sample string 12",
"PaymentPlanID": 13,
"Payments": [
{
"Amount": 1.0,
"PaymentDate": "2025-11-03T15:53:01.8889561Z",
"PaymentID": 1
},
{
"Amount": 1.0,
"PaymentDate": "2025-11-03T15:53:01.8889561Z",
"PaymentID": 1
}
],
"RemainingBalance": 14.0,
"PaymentCount": 15,
"PaymentPlanType": "Fixed",
"PPD": true,
"StartDate": "2025-11-03T15:53:01.904544Z",
"Status": "Active",
"Term": 18,
"UpdateDate": "2025-11-03T15:53:01.904544Z"
}
],
"RecurringPayments": [
{
"AccountLevelAddonPayments": [
{
"AddonCode": "sample string 1",
"AddonName": "sample string 2",
"Amount": 3.0
},
{
"AddonCode": "sample string 1",
"AddonName": "sample string 2",
"Amount": 3.0
}
],
"AutoDebit": true,
"BillerID": 2,
"BillingAccountID": 1,
"CreatedByCSR": true,
"CustomerID": 4,
"DayToPay": 1,
"DisplayDescription": "sample string 5",
"EmailThisManyDaysBeforeBillDue": 1,
"LastPaymentAccountNumber": "sample string 6",
"LastPaymentAmount": 1.0,
"LastPaymentConfirmationNumber": "sample string 7",
"LastPaymentDate": "2025-11-03T15:53:01.904544Z",
"MonthlyAmount": 1.0,
"NumberOfPayments": 1,
"OtherData": "sample string 8",
"RecurringPaymentID": 9,
"PayAllOutstandingBills": true,
"PaymentAccountToken": "sample string 11",
"PaymentAmountType": "AmountDue",
"PaymentName": "sample string 12",
"PayOnType": "UponReceipt",
"PayUntilDescription": "sample string 13",
"PayUntilType": "I_tell_you_to_stop",
"PlanType": "RecurringPayment",
"PPD": true,
"SetupDate": "2025-11-03T15:53:01.904544Z",
"StartDate": "2025-11-03T15:53:01.904544Z",
"Status": "Active",
"RecurringPaymentType": "UponReceipt_AmountDue",
"ReferenceNumber": "sample string 17",
"SendRecurringEmailReminder": true,
"SendEmailNotification": true,
"StopPaymentOn": "2025-11-03T15:53:01.904544Z",
"UpToAmount": 1.0,
"UserLevelAddonPayments": [
{
"AddonCode": "sample string 1",
"AddonName": "sample string 2",
"Amount": 3.0
},
{
"AddonCode": "sample string 1",
"AddonName": "sample string 2",
"Amount": 3.0
}
]
},
{
"AccountLevelAddonPayments": [
{
"AddonCode": "sample string 1",
"AddonName": "sample string 2",
"Amount": 3.0
},
{
"AddonCode": "sample string 1",
"AddonName": "sample string 2",
"Amount": 3.0
}
],
"AutoDebit": true,
"BillerID": 2,
"BillingAccountID": 1,
"CreatedByCSR": true,
"CustomerID": 4,
"DayToPay": 1,
"DisplayDescription": "sample string 5",
"EmailThisManyDaysBeforeBillDue": 1,
"LastPaymentAccountNumber": "sample string 6",
"LastPaymentAmount": 1.0,
"LastPaymentConfirmationNumber": "sample string 7",
"LastPaymentDate": "2025-11-03T15:53:01.904544Z",
"MonthlyAmount": 1.0,
"NumberOfPayments": 1,
"OtherData": "sample string 8",
"RecurringPaymentID": 9,
"PayAllOutstandingBills": true,
"PaymentAccountToken": "sample string 11",
"PaymentAmountType": "AmountDue",
"PaymentName": "sample string 12",
"PayOnType": "UponReceipt",
"PayUntilDescription": "sample string 13",
"PayUntilType": "I_tell_you_to_stop",
"PlanType": "RecurringPayment",
"PPD": true,
"SetupDate": "2025-11-03T15:53:01.904544Z",
"StartDate": "2025-11-03T15:53:01.904544Z",
"Status": "Active",
"RecurringPaymentType": "UponReceipt_AmountDue",
"ReferenceNumber": "sample string 17",
"SendRecurringEmailReminder": true,
"SendEmailNotification": true,
"StopPaymentOn": "2025-11-03T15:53:01.904544Z",
"UpToAmount": 1.0,
"UserLevelAddonPayments": [
{
"AddonCode": "sample string 1",
"AddonName": "sample string 2",
"Amount": 3.0
},
{
"AddonCode": "sample string 1",
"AddonName": "sample string 2",
"Amount": 3.0
}
]
}
],
"Stopped": true,
"UnEnrolledDate": "2025-11-03T15:53:01.904544Z",
"IsMasterEntity": true
},
"Success": true
}