Payments Search Keys

  • account_num — Specify the associated Account Number.

  • account_name — Specify the associated Account Name.

  • payment_date — Specify the Payment Date of the desired payment.

  • id — Specify the ID of the desired Payment.

  • status— Specify the Status of the desired payment. Possible values are the following: Draft, Processing, Completed, Void, Processing_error, Merchant_verification, Merchant_verification_failed, Canceled, Allocated_error, External_review, Two_step_verification, Failed_void, Connection_test_succeeded, Connection_test_failed.

  • payment_method_type— Specify the Payment Method of the desired payment. Possible values are the following: Bank (displayed as Bank Draft in UI), Credit-card, Cash, Check, Referenced-credit-card, Pay-by-pay-pal, Wire-transfer, Mobile-carrier, Custom, Sepa-dd, Sepa-dd-em, Direct-debit, Tokenized-credit-card, BPay, Tokenized-paypal, Referenced, Tokenized-sepa-dd, Tokenized-bank, iDEAL.

  • currency_type— Specify the Currency of the desired payment.

  • amount — Specify the Amount of payment.

  • unapplied_amount — Specify the Remaining amount of the desired payment.

  • refund_amount — Specify the Refunded amount of the desired payment.

  • cancel_amount — Specify the Canceled amount of the desired payment.

  • retried — Specify whether the desired payment is Retried (true OR false).

  • retry_series_status — Specify the Retry Series Status of the desired payment.

  • retry_series_reason — Specify the Retry Series Reason of the desired payment.

  • payment_batch_type — Specify the Type of payment batch. Possible values are the following: Retry, Auto-recurring (displayed as Auto-Payment in the UI), Manual, Lockbox, Settlement, Bill_cycle_run.

  • reference — Specify the Reference of the desired payment.

  • auth_code — Specify the Auth Code of the desired payment.

  • created_by — Specify the user who created the payment. In the Payments and other data tables, it is represented as the Created by column.

Several parameters can be combined in a single search query. For example:

  • account_name — "Account_03” AND payment_method_type: "Wire Transfer"

  • payment_date — "01/01/2010" AND currency_type: "USD" ANDstatus: "CANCELLED"

  • account_num — "B2" OR "B3" AND cancel_amount: 100