Skip to main content

Outbound Payments

Outbound Payments Error Reference

The table below outlines the error codes returned by our Outbound Payments API. These codes help identify issues such as invalid vendor status, missing or malformed data, unavailable features, and restrictions on actions like cancellation. Each error is paired with an HTTP status code to indicate the type of failure encountered.

Error Code Description Status Code
Key_OutboundPayments_Invoice_FeatureNotEnabled Outbound payments or invoice feature not enabled for merchant. 400
Key_InvalidFields One or more required fields are missing or invalid. For example:
  • VendorId cannot be null or empty.
  • PaymentMethod cannot be null or empty.
  • Amount cannot be null or zero.
  • Data.checkDate must follow the MM-DD-YYYY format.
  • RemittanceData is missing or invalid.
400
Key_InvalidCheckDate Check date cannot be in the past or more than 90 days in the future. 400
Key_InvalidVendorStatus The vendor must be in a valid status to complete this operation. For example:
  • A vendor must be in Approved status to create an outbound payment.
  • A vendor must be in Approved status to be suspended.
  • A vendor must be in Suspended status to be unsuspended.
400
Key_InvalidVendor Invalid vendor ID provided. 400
Key_InvalidPaymentId Invalid outbound payment ID. 400
Key_OutboundPaymentNotFound Outbound payment ID not found. 400
Key_CheckCannotBeCancelled Cannot cancel check in printed, mailed, or delivered status. 400
Internal server error Please contact the server administrator. 500