PayIQ API Help Page

Introduction

Available PayIQ APIs

Handles the authorization of clients and creates the access tokens that allows the remote clients to perform API calls.

API	Description
POST Api/Auth	Requests an access token to access the PayIQ API
POST Api/Auth/AccessToken	Requests an access token to access the PayIQ API

Performs billing account search and supports updating the billing account number when required.

API	Description
GET Api/BillingAccount?CustomerToken={CustomerToken}&ReferenceNumber={ReferenceNumber}&OtherData={OtherData}	Return Billing Account for the specified Reference Number and Other Data
POST Api/BillingAccount/Updater	Updates the Billing Account Number for a specified list of Reference Numbers. Only the Billing Account Number is changed. All other properties, including BillingAccountID, remain unchanged. Important: Use this method only in exceptional cases where updating the Billing Account Number is absolutely necessary.

Performs customer enrollment/un-enrollment/update

API	Description
DELETE Api/Customer/BillingAccount	Unlink (remove) a billing account
DELETE Api/Customer?customerToken={customerToken}&externalUserID={externalUserID}	Unenrolls an existing customer from the system.
GET Api/Customer/ExternalUserID?externalUserID={externalUserID}	Searches for an existing enrolled customer in the system by using the ExternalUserID provided during enrollment.
GET Api/Customer?customerToken={customerToken}	Searches for an existing enrolled customer in the system
POST Api/Customer	Revises an enrolled customer's information.
POST Api/Customer/ListByAccount	Searches for existing enrolled customers in the system by using Reference Number and Other Data.
PUT Api/Customer	Enrolls a customer into the system.
PUT Api/Customer/BillingAccount	Link (Add) a billing account

Manages disputes

API	Description
DELETE Api/Dispute	Cancel the specified Dispute
GET Api/Dispute/Invoice?CustomerToken={CustomerToken}&ReferenceNumber={ReferenceNumber}&OtherData={OtherData}&BillerInvoiceNo={BillerInvoiceNo}	Search for existing dispute in the system by ReferenceNumber and BillerInvoiceNo
GET Api/Dispute?CustomerToken={CustomerToken}&DisputeExternalID={DisputeExternalID}	Search for existing dispute in the system
POST Api/Dispute	Update properties of the specified Dispute
PUT Api/Dispute	Add new Dispute for the specified Invoice

Manages FDIs

API	Description
DELETE Api/FDI?id={id}	Soft deletes an existing FDI in the system.
GET Api/FDI?ActiveOnly={ActiveOnly}&IncludeDeleted={IncludeDeleted}&FDICode={FDICode}&Page={Page}&PageSize={PageSize}	Searches for an existing FDI in the system.
POST Api/FDI	Updates an existing FDI in the system.
PUT Api/FDI	Adds new FDI in the system.

Performs invoice add, update or search

API	Description
GET Api/Invoice?CustomerToken={CustomerToken}&MasterEntityLevel={MasterEntityLevel}&OnlyOneTime={OnlyOneTime}&Page={Page}&PageSize={PageSize}&AmountDueFrom={AmountDueFrom}&AmountDueTo={AmountDueTo}&AsCustomer={AsCustomer}&BillerInvoiceNo={BillerInvoiceNo}&BillingAccountID={BillingAccountID}&CreditMemos={CreditMemos}&DueDateFrom={DueDateFrom}&DueDateTo={DueDateTo}&Filter={Filter}&HasPromise={HasPromise}&HideExpired={HideExpired}&IncludeCreditMemos={IncludeCreditMemos}&InvoiceAgeFrom={InvoiceAgeFrom}&InvoiceAgeTo={InvoiceAgeTo}&InvoiceCategory={InvoiceCategory}&LookbackDate={LookbackDate}&Name={Name}&OtherData={OtherData}&ReferenceNumber={ReferenceNumber}&Sort={Sort}&StatementDateFrom={StatementDateFrom}&StatementDateTo={StatementDateTo}&Type={Type}&DisplayField1={DisplayField1}&DisplayField2={DisplayField2}&DisplayField3={DisplayField3}&DisplayField4={DisplayField4}&DisplayField5={DisplayField5}	Searches for an existing invoice in the system.
PUT Api/Invoice	Insert or update invoices into the system.

API

Description

Searches for an existing invoice in the system.

Insert or update invoices into the system.

Performs payment search and submission

API	Description
DELETE Api/Payment	Reverses an existing payment in the system.
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.
POST Api/Payment/CalculateFee	Calculate the applicable fees for a payment request.
POST Api/Payment/CalculateFeeRefund	Calculate the applicable fees for a refund.
POST Api/Payment/UI	Requests a URL for the external payment verification screen
PUT Api/Payment	Submit a payment request to the system.

Performs payment account related tasks

API	Description
DELETE Api/PaymentAccount?CustomerToken={CustomerToken}&ExternalUserID={ExternalUserID}&Token={Token}	Deletes an existing payment account from the system.
GET Api/PaymentAccount/RTPEligibility?routingNumber={routingNumber}	Returns if the routing number is eligible for RTP.
POST Api/PaymentAccount/ConvertJSToken	Converts a temporary payment account token received from the JavaScript API into a permanent payment account token.
POST Api/PaymentAccount/JS	Returns a URL for the payment account entry screen
POST Api/PaymentAccount/UI	Returns a URL for the payment account entry screen

Manages payment plans for enrolled customers

API	Description
DELETE Api/PaymentPlan?customerToken={customerToken}&paymentPlanID={paymentPlanID}	Deletes an existing payment plan from the system.
POST Api/PaymentPlan	Revise an existing payment plan in the system.
POST Api/PaymentPlan/Setup	Returns the available setup parameters for a payment plan
PUT Api/PaymentPlan	Submits a new payment plan into the system

Manages promises

API	Description
DELETE Api/Promise	Cancel Promises for a list of Invoices
GET Api/Promise?CustomerToken={CustomerToken}&BillID={BillID}&BillerInvoiceNo={BillerInvoiceNo}&ExternalInvoiceID={ExternalInvoiceID}&OtherData={OtherData}&ReferenceNumber={ReferenceNumber}	Return Promise data for the specified Invoice
PUT Api/Promise	Add or update Promises for a list of Invoices

Manages recurring payments for enrolled customers

API	Description
DELETE Api/RecurringPayment	Deletes an existing recurring payment from the system.
POST Api/RecurringPayment	Revise an existing recurring payment in the system.
PUT Api/RecurringPayment	Submits a new recurring payment into the system