Search e-bills requests.

post

https://api.securelyme.io/e-bills/search

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

externalIdentifier

string

External identifier for recurring request. Expected to be a unique identifier from the API consumer's system.

createdFromDate

date-time

Starting date range to search for payment requests by created date.

createdToDate

date-time

Ending date range to search for payment requests by created date.

invoiceNumber

string

Invoice number of payment request.

statusCodes

array of strings

List of payment request statuses to include in the search (PENDING, ACTIVE, CANCELLED, PAYMENTREJECTED, DELETED, SUSPENDED, REQUESTEDCANCELLATION, VIEWED, EXPIRED, ENDED, COMPLETED).

statusCodes

paymentFrequencies

array of strings

List of subscription frequency type to include in the search (ONCE, WEEKLY, EVERYOTHERWEEK, BIMONTHLY, MONTHLY, QUARTERLY, YEARLY).

paymentFrequencies

customerId

int32

Id of customer associated to payment request. Searches on customer id will ignore other customer searches (first name, last name, company name, email, phone and account number).

customerExternalIdentifier

string

External identifier for consumer. Expected to be a unique identifier from the API consumer's system.

firstName

string

First name of customer associated to payment request.

lastName

string

Last name of customer associated to payment request.

companyName

string

Company name of customer associated to payment request.

string

Email of customer associated to payment request.

phone

string

Cell phone of customer associated to payment request.

accountNumber

string

Account number of customer associated to payment request.

memo

string

Memo set by the merchant on each subscription.

pageSize

int32

1 to 100

Defaults to 20

Number of payment requests to return per page.

page

int32

1 to 2147483647

Defaults to 1

Which page of the results set. Starts with page 1.

Response

200List of e-bills matching the search request.