Billing

payment

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

Read · 3

search get by id

Write · 2

create createRefund

Read operations

search/payment/searchTry it

search payment

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

officeIDsinteger

Office Unique Identifier

paymentIDsinteger

Payment Unique Identifier

customerIDsinteger

Customer Unique Identifier

amountdouble

Amount of Payment

datestring

Payment date

paymentMethodinteger

Payment Method 0-Coupon, 1-Cash, 2-Check, 3-Credit Card, 4 ACH

statusinteger

Status of the payment (0-Unsuccessful, 1-Successful, 2-Refunded)

dateAppliedstring

Date the payment was applied

Returns

paymentIDsarray

No description in the upstream reference.

Request

/payment/search

curl -X POST 'https://{subdomain}.pestroutes.com/api/payment/search' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'Accept: application/json' \
  --data-urlencode 'officeIDs=1' \
  --data-urlencode 'paymentIDs=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/payment/getTry it

get payment

Get Bulk data for payment. Accepts an array of paymentIDs. Returns a max of 1000 records.

Parameters

paymentIDsarray

No description in the upstream reference.

Returns

paymentIDinteger

Payment Unique Identifier

officeIDinteger

Office Unique Identifier

customerIDinteger

Customer Unique Identifier

datestring

Payment date

paymentMethodinteger

Payment Method 0-Coupon, 1-Cash, 2-Check, 3-Credit Card, 4 ACH, 5-Credit Memo

amountdouble

Payment amount

appliedAmountdouble

Amount of the payment that was used

unassignedAmountdouble

Amount of the payment that was not used yet

Request

/payment/get

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

Response

success:true

]

count:2

}

by id/payment/{id}Try it

Fetch by id payment

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

Parameters

No parameters beyond authentication.

Returns

paymentIDinteger

Payment Unique Identifier

officeIDinteger

Office Unique Identifier

customerIDinteger

Customer Unique Identifier

datestring

Payment date

paymentMethodinteger

Payment Method 0-Coupon, 1-Cash, 2-Check, 3-Credit Card, 4 ACH, 5-Credit Memo

amountdouble

Payment amount

appliedAmountdouble

Amount of the payment that was used

unassignedAmountdouble

Amount of the payment that was not used yet

Request

/payment/{id}

curl -X POST 'https://{subdomain}.pestroutes.com/api/payment/{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

paymentID:4468

officeID:2602

customerID:2124

date:"2026-05-06 00:00:00"

paymentMethod:2

amount:21.5

appliedAmount:74.5

unassignedAmount:12.5

status:2

invoiceIDs:0

paymentApplications:"sample-paymentApplications"

employeeID:5916

officePayment:0

collectionPayment:0

writeOff:1

paymentOrigin:0

originalPaymentID:1219

lastFour:"sample-lastFour"

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

batchOpened:"sample-batchOpened"

batchClosed:"sample-batchClosed"

paymentSource:"sample-paymentSource"

}

Write operations

create/payment/createTry it

create payment

Parameters

employeeIDinteger

Employee to associate with the payment

notesinteger

Description for this payment

ticketIDinteger

Limit payment to this ticket

subscriptionIDinteger

Limit payment to this subscription

Returns

Returns a success acknowledgement.

Request

/payment/create

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

Response

success:true

paymentID:4821

}

createRefund/payment/createRefundTry it

createRefund payment

Parameters

amountdouble

Amount this payment was for

Returns

Returns a success acknowledgement.

Request

/payment/createRefund

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

Response

success:true

paymentID:4821

}