GET Api/Payment?CustomerToken={CustomerToken}&Page={Page}&PageSize={PageSize}&AmountFrom={AmountFrom}&AmountTo={AmountTo}&BillingAccountID={BillingAccountID}&BillerInvoiceNo={BillerInvoiceNo}&CreatedFrom={CreatedFrom}&CreatedTo={CreatedTo}&InvoiceAmountFrom={InvoiceAmountFrom}&InvoiceAmountTo={InvoiceAmountTo}&Name={Name}&ProcessedFrom={ProcessedFrom}&ProcessedTo={ProcessedTo}&ReferenceNumber={ReferenceNumber}&Status={Status}&TransactionID={TransactionID}&Filter={Filter}&Sort={Sort}

Searches for existing payments in the system.

Request Information

URI Parameters

Name	Description	Type	Additional information
AmountFrom	Payment amount range start	decimal?	None.
AmountTo	Payment amount range end	decimal?	None.
BillerInvoiceNo	Invoice biler generated by the biller.	string	String length: inclusive between 0 and 50
CreatedFrom	Payment created date start	date-time?	None.
CreatedTo	Payment created date end	date-time?	None.
CustomerToken	For enrolled payment search requests, contains the unique customer token used to identify the customer performing the search.	string	None.
Filter		string	String length: inclusive between 0 and 2048
InvoiceAmountFrom	Invoice payment amount range start	decimal?	None.
InvoiceAmountTo	Invoice payment amount range end	decimal?	None.
Name	Customer name	string	String length: inclusive between 0 and 50
Page	Specifies the page to return in the result set. Defaults to 1.	int?	None.
PageSize	Specifies the number of records to return per-page. Defaults to 50.	int?	None.
ProcessedFrom	Payment processing date start	date-time?	None.
ProcessedTo	Payment processing date end	date-time?	None.
ReferenceNumber	Billing account reference number	string	String length: inclusive between 0 and 100
Sort		string	String length: inclusive between 0 and 100
Status	Payment status	PaymentStatusType	None.
TransactionID	Specifies a specific transaction ID	long?	None.

Body Parameters

None.

Response Information

Resource Description

Searches for existing payments in the system.

APIPaymentSearchResponseModel

Name	Description	Type	Additional information
ErrorCode	Name of the error condition. See ErrorCode model for details.	ErrorCode	None.
ErrorID	Internal error identification number that uniquely identifies this specific error that occurred.	string	None.
ErrorNum	Numeric value of the ErrorCode	int	None.
Errors	List of errors that occurred when searching for the payments.	Collection of string	None.
Result		PaymentSearchResponseModel	None.
Success	Indicates sucess or failure of the REST request.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": "None",
  "ErrorID": "sample string 1",
  "ErrorNum": 0,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ],
  "Result": {
    "Payments": [
      {
        "AchCompanyID": "sample string 1",
        "AchCompanyName": "sample string 2",
        "AchDepositoryDDA": "sample string 3",
        "AchRoutingTransitNumber": "sample string 4",
        "ApprovedByUserID": 1,
        "ATMTraceID": "sample string 5",
        "BillerID": 6,
        "CCDataProcessingLevel": 7,
        "CcMID": "sample string 8",
        "CellPhone": "sample string 9",
        "Channel": "Enrolled",
        "CombinedFees": [
          {
            "ID": 1,
            "Total": 2.0,
            "CurrencySymbol": "sample string 3"
          },
          {
            "ID": 1,
            "Total": 2.0,
            "CurrencySymbol": "sample string 3"
          }
        ],
        "CreateDate": "2025-05-21T06:35:33.406444Z",
        "CreatedByUserID": 1,
        "CurrencySymbol": "sample string 11",
        "CustomerName": "sample string 12",
        "CustomerToken": "sample string 13",
        "DisplayField1": "sample string 14",
        "DisplayField2": "sample string 15",
        "DisplayField3": "sample string 16",
        "DisplayField4": "sample string 17",
        "DisplayField5": "sample string 18",
        "Email": "sample string 19",
        "EntryField1": "sample string 20",
        "EntryField2": "sample string 21",
        "EntryField3": "sample string 22",
        "EntryField4": "sample string 23",
        "EntryField5": "sample string 24",
        "ExternalUserID": "sample string 25",
        "FDIDescription": "sample string 26",
        "HasMultipleAccounts": true,
        "ID": 28,
        "InvoicePayments": [
          {
            "AccountNumber": "sample string 1",
            "AdditionalFields": {
              "Fields": [
                {
                  "BillerId": 1,
                  "FieldName": "sample string 2",
                  "FieldOrder": 3,
                  "FieldText": "sample string 4",
                  "FieldValue": "sample string 5",
                  "ID": 6,
                  "InvoiceId": 7,
                  "IsEditable": true,
                  "IsRequired": true
                },
                {
                  "BillerId": 1,
                  "FieldName": "sample string 2",
                  "FieldOrder": 3,
                  "FieldText": "sample string 4",
                  "FieldValue": "sample string 5",
                  "ID": 6,
                  "InvoiceId": 7,
                  "IsEditable": true,
                  "IsRequired": true
                }
              ]
            },
            "AddonCode": "sample string 2",
            "AddonName": "sample string 3",
            "Amount": 1.0,
            "AmountDue": 1.0,
            "BillID": 1,
            "BillingAccountDescription": "sample string 4",
            "BillingAccountIsAddOn": true,
            "BillerInvoiceNo": "sample string 6",
            "BillerRemittanceField1": "sample string 7",
            "BillerRemittanceField2": "sample string 8",
            "BillerRemittanceField3": "sample string 9",
            "BillerRemittanceField4": "sample string 10",
            "BillerRemittanceField5": "sample string 11",
            "DisplayField1": "sample string 12",
            "DisplayField2": "sample string 13",
            "DisplayField3": "sample string 14",
            "DisplayField4": "sample string 15",
            "DisplayField5": "sample string 16",
            "DueDate": "2025-05-21T06:35:33.4220848Z",
            "EntryField1": "sample string 17",
            "EntryField2": "sample string 18",
            "EntryField3": "sample string 19",
            "EntryField4": "sample string 20",
            "EntryField5": "sample string 21",
            "FDICode": "sample string 22",
            "FreeformText": "sample string 23",
            "ID": 24,
            "IsAddOn": true,
            "IsCreditMemo": true,
            "PaymentAmount": 1.0,
            "PaymentCode": "sample string 27",
            "PaymentCodeReason": "sample string 28",
            "ReferenceNumber": "sample string 29",
            "RefundableAmount": 30.0,
            "ReversalAmount": 1.0,
            "StatementDate": "2025-05-21T06:35:33.4220848Z",
            "TransactionType": "sample string 31"
          },
          {
            "AccountNumber": "sample string 1",
            "AdditionalFields": {
              "Fields": [
                {
                  "BillerId": 1,
                  "FieldName": "sample string 2",
                  "FieldOrder": 3,
                  "FieldText": "sample string 4",
                  "FieldValue": "sample string 5",
                  "ID": 6,
                  "InvoiceId": 7,
                  "IsEditable": true,
                  "IsRequired": true
                },
                {
                  "BillerId": 1,
                  "FieldName": "sample string 2",
                  "FieldOrder": 3,
                  "FieldText": "sample string 4",
                  "FieldValue": "sample string 5",
                  "ID": 6,
                  "InvoiceId": 7,
                  "IsEditable": true,
                  "IsRequired": true
                }
              ]
            },
            "AddonCode": "sample string 2",
            "AddonName": "sample string 3",
            "Amount": 1.0,
            "AmountDue": 1.0,
            "BillID": 1,
            "BillingAccountDescription": "sample string 4",
            "BillingAccountIsAddOn": true,
            "BillerInvoiceNo": "sample string 6",
            "BillerRemittanceField1": "sample string 7",
            "BillerRemittanceField2": "sample string 8",
            "BillerRemittanceField3": "sample string 9",
            "BillerRemittanceField4": "sample string 10",
            "BillerRemittanceField5": "sample string 11",
            "DisplayField1": "sample string 12",
            "DisplayField2": "sample string 13",
            "DisplayField3": "sample string 14",
            "DisplayField4": "sample string 15",
            "DisplayField5": "sample string 16",
            "DueDate": "2025-05-21T06:35:33.4220848Z",
            "EntryField1": "sample string 17",
            "EntryField2": "sample string 18",
            "EntryField3": "sample string 19",
            "EntryField4": "sample string 20",
            "EntryField5": "sample string 21",
            "FDICode": "sample string 22",
            "FreeformText": "sample string 23",
            "ID": 24,
            "IsAddOn": true,
            "IsCreditMemo": true,
            "PaymentAmount": 1.0,
            "PaymentCode": "sample string 27",
            "PaymentCodeReason": "sample string 28",
            "ReferenceNumber": "sample string 29",
            "RefundableAmount": 30.0,
            "ReversalAmount": 1.0,
            "StatementDate": "2025-05-21T06:35:33.4220848Z",
            "TransactionType": "sample string 31"
          }
        ],
        "InvoicePaymentCount": 29,
        "IsEnrolled": true,
        "IsFees": true,
        "IsFutureDated": true,
        "IsPreSettlement": true,
        "IsReversal": true,
        "IsPaymentConsolidatorPayment": true,
        "Method": "ACH",
        "PaymentAccountAchUsageType": "Unknown",
        "PaymentAccountAchType": "Unknown",
        "PaymentAccountCcChargeType": "Unknown",
        "PaymentAccountCcType": "sample string 36",
        "PaymentAccountCode": "sample string 37",
        "PaymentAccountDescription": "sample string 38",
        "PaymentAccountExpiration": "2025-05-21T06:35:33.4220848Z",
        "PaymentAccountLastFour": "sample string 39",
        "PaymentAccountToken": "sample string 40",
        "PaymentAccountType": "ACH",
        "PaymentAccountSwipe": true,
        "PaymentSource": "sample string 42",
        "pcOptionalDate": "2025-05-21T06:35:33.4220848Z",
        "pcReversalReasonID": 1,
        "PluginName": "sample string 43",
        "Phone": "sample string 44",
        "ProcessDate": "2025-05-21T06:35:33.4220848Z",
        "ProcessingType": "Combined",
        "ReportingID": 46,
        "ReversalReasonCode": "sample string 47",
        "ReversalReasonText": "sample string 48",
        "StandardEntryClass": "ARC",
        "Status": "Initiated",
        "Tender": "sample string 49",
        "Total": 50.0,
        "TotalWithFees": 51.0,
        "TraceID": "sample string 52",
        "TransactionID": 53,
        "TransactionOID": "046d49cf-2fb7-4e0b-8753-2ce7cbc0b1cb",
        "ExternalTransactionID": "sample string 54"
      },
      {
        "AchCompanyID": "sample string 1",
        "AchCompanyName": "sample string 2",
        "AchDepositoryDDA": "sample string 3",
        "AchRoutingTransitNumber": "sample string 4",
        "ApprovedByUserID": 1,
        "ATMTraceID": "sample string 5",
        "BillerID": 6,
        "CCDataProcessingLevel": 7,
        "CcMID": "sample string 8",
        "CellPhone": "sample string 9",
        "Channel": "Enrolled",
        "CombinedFees": [
          {
            "ID": 1,
            "Total": 2.0,
            "CurrencySymbol": "sample string 3"
          },
          {
            "ID": 1,
            "Total": 2.0,
            "CurrencySymbol": "sample string 3"
          }
        ],
        "CreateDate": "2025-05-21T06:35:33.406444Z",
        "CreatedByUserID": 1,
        "CurrencySymbol": "sample string 11",
        "CustomerName": "sample string 12",
        "CustomerToken": "sample string 13",
        "DisplayField1": "sample string 14",
        "DisplayField2": "sample string 15",
        "DisplayField3": "sample string 16",
        "DisplayField4": "sample string 17",
        "DisplayField5": "sample string 18",
        "Email": "sample string 19",
        "EntryField1": "sample string 20",
        "EntryField2": "sample string 21",
        "EntryField3": "sample string 22",
        "EntryField4": "sample string 23",
        "EntryField5": "sample string 24",
        "ExternalUserID": "sample string 25",
        "FDIDescription": "sample string 26",
        "HasMultipleAccounts": true,
        "ID": 28,
        "InvoicePayments": [
          {
            "AccountNumber": "sample string 1",
            "AdditionalFields": {
              "Fields": [
                {
                  "BillerId": 1,
                  "FieldName": "sample string 2",
                  "FieldOrder": 3,
                  "FieldText": "sample string 4",
                  "FieldValue": "sample string 5",
                  "ID": 6,
                  "InvoiceId": 7,
                  "IsEditable": true,
                  "IsRequired": true
                },
                {
                  "BillerId": 1,
                  "FieldName": "sample string 2",
                  "FieldOrder": 3,
                  "FieldText": "sample string 4",
                  "FieldValue": "sample string 5",
                  "ID": 6,
                  "InvoiceId": 7,
                  "IsEditable": true,
                  "IsRequired": true
                }
              ]
            },
            "AddonCode": "sample string 2",
            "AddonName": "sample string 3",
            "Amount": 1.0,
            "AmountDue": 1.0,
            "BillID": 1,
            "BillingAccountDescription": "sample string 4",
            "BillingAccountIsAddOn": true,
            "BillerInvoiceNo": "sample string 6",
            "BillerRemittanceField1": "sample string 7",
            "BillerRemittanceField2": "sample string 8",
            "BillerRemittanceField3": "sample string 9",
            "BillerRemittanceField4": "sample string 10",
            "BillerRemittanceField5": "sample string 11",
            "DisplayField1": "sample string 12",
            "DisplayField2": "sample string 13",
            "DisplayField3": "sample string 14",
            "DisplayField4": "sample string 15",
            "DisplayField5": "sample string 16",
            "DueDate": "2025-05-21T06:35:33.4220848Z",
            "EntryField1": "sample string 17",
            "EntryField2": "sample string 18",
            "EntryField3": "sample string 19",
            "EntryField4": "sample string 20",
            "EntryField5": "sample string 21",
            "FDICode": "sample string 22",
            "FreeformText": "sample string 23",
            "ID": 24,
            "IsAddOn": true,
            "IsCreditMemo": true,
            "PaymentAmount": 1.0,
            "PaymentCode": "sample string 27",
            "PaymentCodeReason": "sample string 28",
            "ReferenceNumber": "sample string 29",
            "RefundableAmount": 30.0,
            "ReversalAmount": 1.0,
            "StatementDate": "2025-05-21T06:35:33.4220848Z",
            "TransactionType": "sample string 31"
          },
          {
            "AccountNumber": "sample string 1",
            "AdditionalFields": {
              "Fields": [
                {
                  "BillerId": 1,
                  "FieldName": "sample string 2",
                  "FieldOrder": 3,
                  "FieldText": "sample string 4",
                  "FieldValue": "sample string 5",
                  "ID": 6,
                  "InvoiceId": 7,
                  "IsEditable": true,
                  "IsRequired": true
                },
                {
                  "BillerId": 1,
                  "FieldName": "sample string 2",
                  "FieldOrder": 3,
                  "FieldText": "sample string 4",
                  "FieldValue": "sample string 5",
                  "ID": 6,
                  "InvoiceId": 7,
                  "IsEditable": true,
                  "IsRequired": true
                }
              ]
            },
            "AddonCode": "sample string 2",
            "AddonName": "sample string 3",
            "Amount": 1.0,
            "AmountDue": 1.0,
            "BillID": 1,
            "BillingAccountDescription": "sample string 4",
            "BillingAccountIsAddOn": true,
            "BillerInvoiceNo": "sample string 6",
            "BillerRemittanceField1": "sample string 7",
            "BillerRemittanceField2": "sample string 8",
            "BillerRemittanceField3": "sample string 9",
            "BillerRemittanceField4": "sample string 10",
            "BillerRemittanceField5": "sample string 11",
            "DisplayField1": "sample string 12",
            "DisplayField2": "sample string 13",
            "DisplayField3": "sample string 14",
            "DisplayField4": "sample string 15",
            "DisplayField5": "sample string 16",
            "DueDate": "2025-05-21T06:35:33.4220848Z",
            "EntryField1": "sample string 17",
            "EntryField2": "sample string 18",
            "EntryField3": "sample string 19",
            "EntryField4": "sample string 20",
            "EntryField5": "sample string 21",
            "FDICode": "sample string 22",
            "FreeformText": "sample string 23",
            "ID": 24,
            "IsAddOn": true,
            "IsCreditMemo": true,
            "PaymentAmount": 1.0,
            "PaymentCode": "sample string 27",
            "PaymentCodeReason": "sample string 28",
            "ReferenceNumber": "sample string 29",
            "RefundableAmount": 30.0,
            "ReversalAmount": 1.0,
            "StatementDate": "2025-05-21T06:35:33.4220848Z",
            "TransactionType": "sample string 31"
          }
        ],
        "InvoicePaymentCount": 29,
        "IsEnrolled": true,
        "IsFees": true,
        "IsFutureDated": true,
        "IsPreSettlement": true,
        "IsReversal": true,
        "IsPaymentConsolidatorPayment": true,
        "Method": "ACH",
        "PaymentAccountAchUsageType": "Unknown",
        "PaymentAccountAchType": "Unknown",
        "PaymentAccountCcChargeType": "Unknown",
        "PaymentAccountCcType": "sample string 36",
        "PaymentAccountCode": "sample string 37",
        "PaymentAccountDescription": "sample string 38",
        "PaymentAccountExpiration": "2025-05-21T06:35:33.4220848Z",
        "PaymentAccountLastFour": "sample string 39",
        "PaymentAccountToken": "sample string 40",
        "PaymentAccountType": "ACH",
        "PaymentAccountSwipe": true,
        "PaymentSource": "sample string 42",
        "pcOptionalDate": "2025-05-21T06:35:33.4220848Z",
        "pcReversalReasonID": 1,
        "PluginName": "sample string 43",
        "Phone": "sample string 44",
        "ProcessDate": "2025-05-21T06:35:33.4220848Z",
        "ProcessingType": "Combined",
        "ReportingID": 46,
        "ReversalReasonCode": "sample string 47",
        "ReversalReasonText": "sample string 48",
        "StandardEntryClass": "ARC",
        "Status": "Initiated",
        "Tender": "sample string 49",
        "Total": 50.0,
        "TotalWithFees": 51.0,
        "TraceID": "sample string 52",
        "TransactionID": 53,
        "TransactionOID": "046d49cf-2fb7-4e0b-8753-2ce7cbc0b1cb",
        "ExternalTransactionID": "sample string 54"
      }
    ],
    "TotalRecords": 1
  },
  "Success": true
}