API – Payment Status Collection
This collection is used to display payment status. This is not the LoanPro payment status, but the status received from the processor. What that means is when the processor reports a new payment status, it is sent to Secure Payments and then passed to LoanPro. For ACH payments, this may happen over several days.
This collection can be found in the payment_info_entity table.
The following values are used for payment status:
- 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 by 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.