CHcheckhq

Retry a payment or refund

Retries the payment's latest attempted money movement. Normally, this retries a failed payment to its original recipient. Retrying a failed employee or contractor disbursement requires an active bank_account owned by that recipient. For a payment with status refund_failed and a failed employer refund attempt, this retries the employer refund by ACH and requires an active bank_account owned by the employer that differs from the account used by the failed refund. If no employer refund attempt was created, start the refund again instead. Refunds for payrolls funded by a payroll advance cannot be retried.

post/payments/{payment}/retry

Request

Path parameters

paymentstring required

ID of the payment desired for retry.

Request body

use_wireboolean

Boolean parameter indicating whether a wire retry is desired

bank_accountstring

An active bank account to use for the retry. For a failed employee or contractor disbursement, this parameter is required and the account must belong to the recipient. For a failed employer debit, omit it to reuse the payment's current bank account. For a refund_failed payment with a failed employer refund attempt, this parameter is required and the account must belong to the employer and differ from the account used by the failed refund.

payment_typestring

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
directionstring

Example response

{
  "id": "pyt_vIFHhvyGN47ej1upyIT8",
  "status": "failed",
  "amount": "4522.0400",
  "type": "company_cash_requirement",
  "parent_type": "payroll",
  "parent_id": "pay_ENA4k8LMHbgpV07GLGSv",
  "payment_attempts": [
    {
      "id": "pya_GaeJoEAzbqqc2D9GMfOF",
      "created_at": "2022-02-18T21:32:44.957364Z",
      "expected_completion_date": "2022-02-25",
      "status": "failed",
      "payment_method": "wire",
      "wire_details": {
        "account_number": "3302826020",
        "routing_number": "121140399",
        "bank_name": "Silicon Valley Bank",
        "account_name": "SVB for benefit of CHECK TECHNOLOGIES",
        "account_address": "3003 Tasman Drive, Santa Clara, CA 95054",
        "amount": 4522.04
      }
    }
  ],
  "direction": "debit"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.