Payments Overview

Gain visibility into employer debit and employee credit payments using the Payments API

Visible payments in the API include

  1. Debit payments used to fund payrolls
  2. Credit payments used to pay employees or contractors.

Payment Lifecycle

Payments in Check's API can carry a status of one of the following:

  • draft - Indicative of a payment for a payroll that has not yet been processed.
  • processing - Indicative of a payment that is "in-flight."
  • paid - Indicative of a payment that has completed and has been completed.
  • failed - Indicative of a payment that has failed to complete. Payments in this status can be recovered using the /retry or /refund endpoints.
  • refunded - Indicative of a payment that has been refunded. Once a payment has been refunded, it cannot be undone.