CHcheckhq

Cancel a payment

Changed on
post/payments/{payment}/cancel

Request

Path parameters

paymentstring required

Response

200

idstring
statusstring
amountstring
typestring
parent_typestring

The parent type of the payment. One of payroll, payroll_item, contractor_payment, collection, refund, or correction. Payments that fund a correction report correction as the parent type.

parent_idstring

The id of the parent of the payment (see parent_type). An id can be a pay_..., itm_..., cpa_..., pyt_..., or cor_... id. When parent_type is correction, this is the correction's id.

can_retryboolean
can_refundboolean
can_cancelboolean
cancel_deadlinestring
directionstring
companystring
can_reverseboolean

Whether this payment can be reversed with POST /payments/{payment}/reverse. Present for partners enrolled in the Corrections API preview; omitted otherwise.

reversal_deadlinestring date-time nullable

Last datetime by which a paid ACH credit for a payroll item or contractor payment can be reversed. Present for partners enrolled in the Corrections API preview; omitted otherwise.

Example response

{
  "id": "pyt_vIFHhvyGN47ej1upyIT8",
  "status": "failed",
  "amount": "4522.0400",
  "type": "employee_net_pay",
  "parent_type": "payroll_item",
  "parent_id": "itm_ENA4k8LMHbgpV07GLGSv",
  "payment_attempts": [
    {
      "id": "pya_Kgl6ERboridVSfv4XKdT",
      "created_at": "2022-02-18T20:14:40.713837Z",
      "expected_completion_date": "2022-02-23",
      "status": "canceled",
      "payment_method": "ach",
      "payment_instrument": "bnk_W7hjDGn6sU1d3U8dr9bq"
    }
  ],
  "cancel_deadline": "2022-02-19T17:00:00.000Z",
  "direction": "credit",
  "company": "com_ENA4k8LMHbgpV07GLGSv",
  "reversal_deadline": "2022-02-24T01:00:00.000Z"
}

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status