API – Payments Collections
- 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)
- Card Payment Fee Types (loan.cardfee.types)
- Payment Processor (payment.processor)
- Reversed Payments (payment.reverse)
- Payment Status (payment.status)
- Payment Account Type (paymentAccount.type)
These are the collections related to payments in the API.
Payment Applications (payment.application)
Diverts a specific amount of payment to discount
Diverts a specific amount of payment to escrow
Diverts a specific amount of payment to fees
Diverts a specific amount of payment to interest
Diverts a specific amount of payment to pay off fees
Diverts a specific amount of payment to principal
Diverts a specific amount of payment to principal balance
Payment eCheck Processor (payment.echeck.processor)
eCheck is processed through Balanced Payments.
eCheck is processed through Check 21.
eCheck is processed through Forte.
eCheck is processed through InterceptEFT. (This processor is not an option anymore.)
eCheck is processed through SpeedChex.
Payment eCheck Authorization Type (payment.echeckauth)
CCD – Company Signature
PPD – Individual Signature
Extra Towards – Between Periods (payment.extra.periods)
Extra applies towards next payment
Extra applies only towards the principal.
Extra Towards – Between Transactions (payment.extra.tx)
Extra applies to principal and affects next due date
Extra applies to only principal and does not affect next due date.
Extra applies to the past due amount, then the next due amount, then the principal only
Extra applies to the current amount due, then the next two scheduled payments, then principal only
Payment Method (payment.methods)
The payment method is cash.
The payment method is a check.
The payment method is a debit card.
The payment method is direct deposit.
The payment method is an echeck.
The payment is a Canadian transaction.
The payment method is email transfer.
Used to create a custom payment method.
Payment method is cash service.
Payment method is through wage garnishment or diverted wages.
Card Payment Fee Types (loan.cardfee.types)
Waive Card Payment Fee
Greater of Fee or Percentage
Lesser of Fee or Percentage
Payment Processor (payment.processor)
Payment is processed through authorize.net
Payment is processed through Versapay
Reversed Payments (payment.reverse)
Insufficient funds from a Canadian bank
Insufficient funds, causing a check to bounce
Insufficient funds from a U.S. bank
Payment Status (payment.status)
(None) No payment status has been received from the processor.
(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.
(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.
(Failed) The processor was unable to process the payment.
(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.
(Pending) The payment has been received by the processor, but has not yet been processed.
(Pending Refund) The merchant has requested that the payment be refunded, but the funds have not yet settled to the originating account.
(Refunded) The payment was successfully processed, but then refunded. This status means the refund is complete and funds have settled.
(Settled) Funds for the payment have been received by the merchant.
(Success) This means that a requested payment processed successfully. Depending on the processor and payment type, funds may not have settled yet.
(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).
(Voided) A void was completed, which stops a payment from processing after it was submitted to the processor.
Payment Account Type (paymentAccount.type)
Used for credit card payment profiles
Used for checking account payment profile