Customers & Sales

paymentProfile

5 endpoints. Start at search to collect IDs, then resolve them through get.

Read · 3

search get by id

Write · 2

create update

Read operations

search/paymentProfile/searchTry it

search paymentProfile

Provide a set of parameters which will return a list of ids. There is no limit to the number of IDs this will return. You can then supply these ids to the get endpoint in order to retrieve bulk data. Every parameter available supports a simple value OR a powerful query object that gives you access to all basic comparators.

Example

dateAdded={"operator":">","value":"2016-01-01"}

Example

dateAdded={"operator\":\"BETWEEN\",\"value\":[\"2016-05-12\",\"2016-05-13\"]}

Available operators

><>=<==!=INBETWEENLIKESTARTSWITHENDSWITHCONTAINS

Each of the search endpoints allows for an optional parameter 'includeData'. When sent, the API will additionally send the resolved objects for the first 1000 IDs.

Keep in mind when using 'includeData' that if there are more than 1000 items an additional property '{entity}IDsNoDataExported' will specify the items that are not included in the resolved data array.

Parameters

paymentProfileIDsinteger

Primary key for the paymentProfile

customerIDsinteger

customer that the paymentProfile belongs to.

officeIDsinteger

OfficeID of the customer that the paymentProfile belongs to.

dateCreatedstring

date the payment profile was created

statusinteger

-1 = soft deleted, 0 = empty, 1 = valid, 2 = invalid, 3 = expired, 4 = last transaction failed

billingStatestring

State associated with the CC/Bank account

billingZipstring

Zip associated with the CC/Bank account

paymentMethodinteger

1=cc, 2 = ach

Returns

paymentProfileIDsarray

No description in the upstream reference.

Request

/paymentProfile/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/paymentProfile/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'paymentProfileIDs=1' \
  --data-urlencode 'customerIDs=1' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

0:10000

1:10007

2:10014

3:10021

4:10028

5:10035

6:10042

7:10049

]

count:8

}

get/paymentProfile/getTry it

get paymentProfile

Get Bulk data for paymentProfile. Accepts an array of paymentProfileIDs. Returns a max of 1000 records.

Parameters

paymentProfileIDsarray

No description in the upstream reference.

Returns

paymentProfileIDinteger

Primary key for the paymentProfile

customerIDinteger

customer that the paymentProfile belongs to.

officeIDinteger

OfficeID of the customer that the paymentProfile belongs to.

createdByinteger

employeeID who created the paymentProfile

descriptionstring

Payment profile description

dateCreatedstring

date the payment profile was created

statusinteger

-1 = soft deleted, 0 = empty, 1 = valid, 2 = invalid, 3 = expired, 4 = last transaction failed

statusNotesstring

No description in the upstream reference.

Request

/paymentProfile/get

curl -X POST 'https://{subdomain}.pestroutes.com/api/paymentProfile/get' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'paymentProfileIDs=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

]

count:2

}

by id/paymentProfile/{id}Try it

Fetch by id paymentProfile

Get paymentProfile data for single ID -- please provide a specific record ID in the URL structure.

Parameters

No parameters beyond authentication.

Returns

paymentProfileIDinteger

Primary key for the paymentProfile

customerIDinteger

customer that the paymentProfile belongs to.

officeIDinteger

OfficeID of the customer that the paymentProfile belongs to.

createdByinteger

employeeID who created the paymentProfile

descriptionstring

Payment profile description

dateCreatedstring

date the payment profile was created

statusinteger

-1 = soft deleted, 0 = empty, 1 = valid, 2 = invalid, 3 = expired, 4 = last transaction failed

statusNotesstring

No description in the upstream reference.

Request

/paymentProfile/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/paymentProfile/{id}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

paymentProfileID:2449

customerID:2124

officeID:2602

createdBy:0

description:"Sample value returned by the mock engine."

dateCreated:"2026-03-03 00:00:00"

status:2

statusNotes:"Active"

billingName:"Quarterly Perimeter"

billingAddress1:"418 Cypress Ridge Rd"

billingAddress2:"418 Cypress Ridge Rd"

billingCountryID:3785

billingCity:"sample-billingCity"

billingState:"sample-billingState"

billingZip:"sample-billingZip"

billingPhone:"5558675309"

billingEmail:"dana.reyes@example.com"

paymentMethod:2

gateway:"sample-gateway"

merchantID:"sample-merchantID"

merchantToken:"sample-merchantToken"

lastFour:"sample-lastFour"

expMonth:"sample-expMonth"

expYear:"sample-expYear"

cardType:"sample-cardType"

bankName:"Quarterly Perimeter"

accountNumber:"sample-accountNumber"

routingNumber:"sample-routingNumber"

checkType:0

accountType:2

failedAttempts:0

sentFailureDate:"2026-03-29 00:00:00"

lastAttemptDate:"2026-06-14 00:00:00"

paymentHoldDate:"2026-04-21 00:00:00"

retryPoints:2

initialTransactionID:"sample-initialTransactionID"

lastDeclineType:"sample-lastDeclineType"

}

Write operations

create/paymentProfile/createTry it

create paymentProfile

Create a payment profile using a CreditCardToken and CreditCardTokenID from braintree/element. This will become the active payment profile for cc/ach.

Parameters

billingNamestring

Billing name associated with payment profile

billingAddress1string

Billing address associated with payment profile

billingAddress2string

Billing address associated with payment profile

billingCitystring

Billing city associated with payment profile

billingStatestring

Billing state associated with payment profile

billingZipinteger

Billing zip code associated with payment profile

billingCountryIDstring

Billing country code associated with payment profile paymentMethod - integer - required 1=cc, 2 = ach

gatewaystring

ACH or CC gateway E.G. authorize, nmi, brain, element

Returns

Returns a success acknowledgement.

Request

/paymentProfile/create

curl -X POST 'https://{subdomain}.pestroutes.com/api/paymentProfile/create' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'billingName=value' \
  --data-urlencode 'billingAddress1=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

paymentProfileID:4821

}

update/paymentProfile/updateTry it

update paymentProfile

Create a payment profile using a CreditCardToken and CreditCardTokenID from braintree/element. This will become the active payment profile for cc/ach.

Parameters

billingFNamestring

Billing name associated with payment profile

billingLNamestring

Billing name associated with payment profile

billingAddress1string

Billing address associated with payment profile

billingAddress2string

Billing address associated with payment profile

billingCitystring

Billing city associated with payment profile

billingStatestring

Billing state associated with payment profile

billingZipinteger

Billing zip code associated with payment profile

billingCountryIDstring

Billing country code associated with payment profile

Returns

Returns a success acknowledgement.

Request

/paymentProfile/update

curl -X POST 'https://{subdomain}.pestroutes.com/api/paymentProfile/update' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'billingFName=value' \
  --data-urlencode 'billingLName=value' \
  --data-urlencode 'authenticationKey=<your-key>' \
  --data-urlencode 'authenticationToken=<your-token>'

Response

success:true

paymentProfileID:4821

}