Payment Statuses

The Payment Statuses section decodes the various transaction statuses you may encounter, offering clarity on what each status signifies for your payments.

Status Definitions

• Canceled: The payment has been canceled.

  • Final Status: Conditional*

  • Notes: Cancellation actions can be undone through the user interface and API, changing this status.

• Paid: The payment has been successfully processed.

  • Final Status: Conditional*

  • Notes: Payments that are returned after achieving 'Paid' status are marked as 'Reversed'.

• Pending: Payment is temporarily on hold; reasons can be found in the pendingStatusReason field.

  • Final Status: No

  • Sub-Statuses: BankAccountValidation, CreditFunding, AdministrativeReturn, PotentialDuplicate, RiskReview, NeedsImageReview.

• Rejected: Payment rejected; reasons can be found in the rejectStatusReason field.

  • Final Status: Conditional*

  • Sub-Statuses: BlockedAccount, RiskReviewReject, BankAccountValidationFailed, BankAccountValidationError, OutstandingRecoveryItem, CreditFundingFailed, DoesNotPassImageReview.

  • Notes: Can be changed if the rejection was made in error.

• Returned: The payment was returned before reaching 'Paid' status.

  • Final Status: Yes

  • Additional Info: returnCode and returnReason.

• Reversed: Payment was returned after reaching 'Paid' status.

  • Final Status: Yes

  • Additional Info: returnCode and returnReason.

• Sent: Payment has been sent to the processing bank.

  • Final Status: No

  • Notes: The duration of this status is configurable.

• Skipped: Skipped in a recurring Payment Template.

  • Final Status: Yes

• Unsent: Payment is eligible for processing but hasn't been sent yet. If payment batching is not enabled for the merchant, newly created payments will initially have this status, unless special criteria such as RiskReview, PotentialDuplicate, or BlockedAccount apply.

  • Final Status: No

  • Special Criteria: RiskReview, PotentialDuplicate, BlockedAccount.

Note: "Conditional" means that under certain conditions, the status may not be final and could be changed.

Understanding Pending Sub-Statuses

In the case of payments marked as "Pending," you may encounter a variety of sub-statuses that provide additional insight into the specific reason a payment is on hold.

Note: Payments that are “Pending” are not eligible to be processed.

Here's what each sub-status means:

• BankAccountValidation: This indicates that the bank account associated with the payment is currently undergoing validation.

• CreditFunding: This sub-status is used when a credit payment is in the process of being funded.

• PotentialDuplicate: This status suggests that the system has detected a payment that appears to be a duplicate of another. This is a flag for review to avoid processing the same payment multiple times.

• RiskReview: This indicates that the payment is undergoing a risk assessment. The payment may remain in this status until the review is completed.

• AdministrativeReturn: This indicates that the payment is currently waiting administrative return correction. The payment will remain in this status until corrective action has been taken.

• NeedsImageReview: This indicates that the payment is waiting image review. The payment will remain in this status until review is completed.

Understanding these sub-statuses can help you diagnose and act on payments that are currently marked as "Pending."

Understanding Rejected Sub-Statuses

In the case of payments marked as "Rejected," you may encounter a variety of sub-statuses that provide additional insight into the specific reason why a payment was rejected.

Note: Payments that are “Rejected” are not eligible to be processed.

Here's what each sub-status means:

• BankAccountValidationError: This status means that an error occurred during the bank account validation process.

• BankAccountValidationFailed: This is more severe than a validation error; it signifies that the bank account validation has definitively failed.

• CreditFundingFailed: If the funding process for a credit payment fails, it will move to this sub-status.

• BlockedAccount: The merchant is restricted from making payments to the specified route and account, usually due to a previous return (e.g., R02 Account Closed).

• RiskReviewReject: The payment did not pass risk review.

• OustandingRecoveryItem: There is an outstanding recovery item and the merchant has opted to not process additional payments for this bank account in this scenario.

• DoesNotPassImageReview: This indicates that the image associated with the payment does not meet requirements and could not be accepted for processing.

Understanding these sub-statuses can help you diagnose and act on payments that are currently marked as "Rejected."