--- updatedAt: 2026-10-07T15:58:38.000Z agentTools: projectIndex: https://docs.checkhq.com/llms.txt --- # Retry a payment Setting the payment\_type parameter to `wire`, `instant`, or `ach` indicates how the failed payment will be retried. Note that only debit payments can be retried using wires. The wire details for this retry attempt are provided in the wire\_details object in the first (most recent) payment attempt after the /retry endpoint is called. Setting the bank\_account parameter indicates the failed payment will be retried using a new bank account. Both credits and debits may be retried using a new bank account. **Retry limits:** A debit can be attempted by ACH at most three times in total. The original debit counts as the first attempt, and any automatic redebits Check sends count toward the limit along with retries you request, including retries to a different bank account. Once a debit has used all three ACH attempts, an ACH retry returns a 400 error and the debit can only be retried by wire. Wire retries have no limit. **Deprecation Notice:** The `use_wire` parameter has been deprecated in favor of the `payment_type` field. If `use_wire` is provided: * When `true`, it is treated as if `payment_type`="wire" was set. * If `payment_type` is also provided, `payment_type` takes precedence, and `use_wire` is ignored. Please update your integrations accordingly. Note that the can\_retry field on the Payment object communicates whether a payment can be retried. We recommend relying on this field to determine whether a retry is possible. A debit that has reached the ACH limit can still show can\_retry as `true`, because a wire retry remains available. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "check-api", "version": "2025-01-01" }, "servers": [ { "url": "https://sandbox.checkhq.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "Authorization", "x-bearer-format": "bearer", "x-default": "YOUR_API_KEY" } } }, "security": [ { "sec0": [] } ], "paths": { "/payments/{payment}/retry": { "post": { "summary": "Retry a payment", "description": "", "operationId": "retry-a-payment", "parameters": [ { "name": "payment", "in": "path", "description": "ID of the payment desired for retry.", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "use_wire": { "type": "boolean", "description": "Boolean parameter indicating whether a wire retry is desired", "default": false }, "bank_account": { "type": "string", "description": "Parameter to accept a new bank account to use to retry this payment." }, "payment_type": { "type": "string" } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"pyt_vIFHhvyGN47ej1upyIT8\",\n \"status\": \"failed\",\n \"amount\": \"4522.0400\",\n \"type\": \"company_cash_requirement\",\n \"parent_type\": \"payroll\",\n \"parent_id\": \"pay_ENA4k8LMHbgpV07GLGSv\",\n \"payment_attempts\": [\n {\n \"id\": \"pya_GaeJoEAzbqqc2D9GMfOF\",\n \"created_at\": \"2022-02-18T21:32:44.957364Z\",\n \"expected_completion_date\": \"2022-02-25\",\n \"status\": \"failed\",\n \"failure_code\": null,\n \"payment_method\": \"wire\",\n \"payment_instrument\": null,\n \"wire_details\": {\n \"account_number\": \"3302826020\",\n \"routing_number\": \"121140399\",\n \"bank_name\": \"Silicon Valley Bank\",\n \"account_name\": \"SVB for benefit of CHECK TECHNOLOGIES\",\n \"account_address\": \"3003 Tasman Drive, Santa Clara, CA 95054\",\n \"amount\": 4522.04\n }\n },\n {\n \"id\": \"pya_Kgl6ERboridVSfv4XKdT\",\n \"created_at\": \"2022-02-18T20:14:40.713837Z\",\n \"expected_completion_date\": \"2022-02-23\",\n \"status\": \"failed\",\n \"failure_code\": null,\n \"payment_method\": \"ach\",\n \"payment_instrument\": \"bnk_W7hjDGn6sU1d3U8dr9bq\",\n \"wire_details\": null\n }\n ],\n \"can_retry\": false,\n \"can_refund\": false,\n \"direction\": \"debit\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "pyt_vIFHhvyGN47ej1upyIT8" }, "status": { "type": "string", "example": "failed" }, "amount": { "type": "string", "example": "4522.0400" }, "type": { "type": "string", "example": "company_cash_requirement" }, "parent_type": { "type": "string", "description": "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.", "example": "payroll" }, "parent_id": { "type": "string", "description": "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.", "example": "pay_ENA4k8LMHbgpV07GLGSv" }, "payment_attempts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "pya_GaeJoEAzbqqc2D9GMfOF" }, "created_at": { "type": "string", "example": "2022-02-18T21:32:44.957364Z" }, "expected_completion_date": { "type": "string", "example": "2022-02-25" }, "status": { "type": "string", "example": "failed" }, "failure_code": {}, "payment_method": { "type": "string", "example": "wire" }, "payment_instrument": {}, "wire_details": { "type": "object", "properties": { "account_number": { "type": "string", "example": "3302826020" }, "routing_number": { "type": "string", "example": "121140399" }, "bank_name": { "type": "string", "example": "Silicon Valley Bank" }, "account_name": { "type": "string", "example": "SVB for benefit of CHECK TECHNOLOGIES" }, "account_address": { "type": "string", "example": "3003 Tasman Drive, Santa Clara, CA 95054" }, "amount": { "type": "number", "example": 4522.04, "default": 0 } } } } } }, "can_retry": { "type": "boolean", "example": false, "default": true }, "can_refund": { "type": "boolean", "example": false, "default": true }, "direction": { "type": "string", "example": "debit" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```