API – Payments Collections
Updated 1 week ago
- General
- Payment Applications (payment.application)
- Payment eCheck Processor (payment.echeck.processor)
- Payment eCheck Authorization Type (payment.echeckauth)
- Extra Towards – Between Periods (payment.extra.periods)
- Extra Towards – Between Transactions (payment.extra.tx)
- Payment Method (payment.methods)
- Payment Processor (payment.processor)
- Reversed Payments (payment.reverse)
- Payment Status (payment.status)
- Payment Account Type (paymentAccount.type)
General
These are the collections related to payments in the API.
Payment Applications (payment.application)
Variable | Description |
payment.application.discount | Diverts a specific amount of payment to discount |
payment.application.escrow | Diverts a specific amount of payment to escrow |
payment.application.fees | Diverts a specific amount of payment to fees |
payment.application.interest | Diverts a specific amount of payment to interest |
payment.application.payoffFees | Diverts a specific amount of payment to pay off fees |
payment.application.principal | Diverts a specific amount of payment to principal |
payment.application.principalBalance | Diverts a specific amount of payment to principal balance |
Payment eCheck Processor (payment.echeck.processor)
Variable | Description |
payment.echeck.processor.balancedpayments | eCheck is processed through Balanced Payments. |
payment.echeck.processor.check21 | eCheck is processed through Check 21. |
payment.echeck.processor.forte | eCheck is processed through Forte. |
payment.echeck.processor.intercepteft | eCheck is processed through InterceptEFT. (This processor is not an option anymore.) |
payment.echeck.processor.speedchex | eCheck is processed through SpeedChex. |
Payment eCheck Authorization Type (payment.echeckauth)
Variable | Description |
payment.echeckauth.CCD | CCD – Company Signature |
payment.echeckauth.PPD | PPD – Individual Signature |
payment.echeckauth.TEL | Telephone |
payment.echeckauth.WEB | Web |
Extra Towards – Between Periods (payment.extra.periods)
Variable | Description |
payment.extra.periods.next | Extra applies towards next payment |
Payment.extra.periods.prinicipalonly | Extra applies only towards the principal. |
Extra Towards – Between Transactions (payment.extra.tx)
Variable | Description |
payment.extra.tx.principal | Extra applies to principal and affects next due date |
payment.extra.tx.principalonly | Extra applies to only principal and does not affect next due date. |
payment.extra.tx.classic | Extra applies to the past due amount, then the next due amount, then the principal only |
payment.extra.tx.classicv2 | Extra applies to the current amount due, then the next two scheduled payments, then principal only |
Payment Method (payment.methods)
Variable | Description |
payment.methods.cash | The payment method is cash. |
payment.methods.check | The payment method is a check. |
payment.methods.debit | The payment method is a debit card. |
payment.methods.directdeposit | The payment method is direct deposit. |
payment.methods.echeck | The payment method is an echeck. |
payment.methods.eft | The payment is a Canadian transaction. |
payment.methods.emailxfer | The payment method is email transfer. |
payment.methods.misc | Miscellaneous |
payment.methods.other | Used to create a custom payment method. |
payment.methods.paynearme | Payment method is cash service. |
payment.methods.payroll | Payment method is through wage garnishment or diverted wages. |
Payment Processor (payment.processor)
Variable | Description |
payment.processor.authorizenet | Payment is processed through authorize.net |
payment.processor.versapay | Payment is processed through Versapay |
Reversed Payments (payment.reverse)
Variable | Description |
payment.reverse.canadaErrorCode | Insufficient funds from a Canadian bank |
payment.reverse.checkBounce | Insufficient funds, causing a check to bounce |
payment.reverse.clericalError | Clerical error |
payment.reverse.nachaErrorCode | Insufficient funds from a U.S. bank |
payment.reverse.nsf | Insufficient funds |
payment.reverse.other | Other |
Payment Status (payment.status)
Variable | Description |
payment.status.none | (None) No payment status has been received from the processor. |
payment.status.approved | (Approved) The payment has been approved by the processor. Approved usually means the transaction will go through, but the funds haven't settled to the receiving account yet. |
payment.status.chargedBack | (Charged Back) The payment has been charged back by the processor. Charge backs are requested by the cardholder and are only relevant to bank-card payments. |
payment.status.failed | (Failed) The processor was unable to process the payment. |
payment.status.inReview | (In Review) The processor is reviewing the payment either because it was requested by the cardholder (possibly for a chargeback) or for other risk assessment or risk management purposes. |
payment.status.pending | (Pending) The payment has been received by the processor, but has not yet been processed. |
payment.status.pendingRefund | (Pending Refund) The merchant has requested that the payment be refunded, but the funds have not yet settled to the originating account. |
payment.status.refunded | (Refunded) The payment was successfully processed, but then refunded. This status means the refund is complete and funds have settled. |
payment.status.settled | (Settled) Funds for the payment have been received by the merchant. |
payment.status.success | (Success) This means that a requested payment processed successfully. Depending on the processor and payment type, funds may not have settled yet. |
payment.status.voidDeclined | (Void Declined) Payments can only be voided when they are still pending. Void declined means a void was requested but could not be completed (usually because the payment is already processing). |
payment.status.voided | (Voided) A void was completed, which stops a payment from processing after it was submitted to the processor. |
Payment Account Type (paymentAccount.type)
Variable | Description |
paymentAccount.type.credit | Used for credit card payment profiles |
paymentAccount.type.checking | Used for checking account payment profile |