v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
PaymentAccounts

Search payment accounts

Search for one or more payment accounts.

get/v1/PaymentAccounts

Query parameters

search.payment_account_idinteger[]

Query by payment account identifier.

search.card_expiration_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by credit card expiration date.

search.card_expiration_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by credit card expiration date.

search.bank_account_namestring[]

Query by bank account name.

search.bank_account_typestring[]

Query by bank account type.

search.bank_namestring[]

Query by bank name.

search.methodstring[]

Query by the method of payment processing.

search.card_name_firststring[]

Query by the first name on the card.

search.card_name_laststring[]

Query by the last name on the card.

search.tokenstring[]

Query by token.

search.merchant_profile_idinteger[]

Quwery by merchant profile identifier.

search.last_used_startstring date-time

Format - date-time (as date-time in RFC3339). Query by last used date.

search.last_used_endstring date-time

Format - date-time (as date-time in RFC3339). Query by last used date.

search.last_process_resultstring[]

Query by the result of the last attempt to process a payment.

search.created_date_startstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.created_date_endstring date-time

Format - date-time (as date-time in RFC3339). Query by created date.

search.created_byinteger[]

Query by the identifier of the user who created a payment account.

search.last_4string[]

Query by last 4 of the credit card or bank account number.

search.customer_idinteger[]

Query by the associated customer's primary identifier.

search.page_sizeinteger

Format - int32. Defines how many items to return at a time.

search.pageinteger

Format - int32. 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.