PaymentMethods

Search payment methods

Search for one or more payment methods.

get/v1/PaymentMethods

Request

Query parameters

search.payment_method_idinteger[]

Query by identifier.

search.descriptionstring[]

Query by description.

search.cc_enabledboolean

Query by credit card payment methods.

search.erate_enabledboolean

Query by erate payment methods.

search.ach_enabledboolean

Query by electronic check payment methods.

search.show_in_customer_portal_flagboolean

Query by payment methods available in billcenter

search.show_in_agent_portal_flagboolean

Query by payment methods available in agent portal

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.

Changes

No recorded changes to this operation across all 2 revisions of this API.