Represents payments and their corresponding attempts for completion initiated by Check on behalf of a company
See the Payments guide for more information
{
"id": "pyt_uzasLBvddSm6aJkHGwQw",
"status": "paid",
"amount": "4522.0400",
"type": "company_cash_requirement",
"parent_type": "payroll",
"parent_id": "pay_aPKCtxqbi1jDNEWRrz9w",
"payment_attempts": [
{
"id": "pya_LUHvXtQBhkNM22xIk8K1",
"created_at": "2022-02-18T20:17:13.033205Z",
"expected_completion_date": "2022-02-23",
"status": "paid",
"failure_code": null,
"payment_method": "ach",
"payment_instrument": "bnk_W7hjDGn6sU1d3U8dr9bq",
"wire_details": null,
"ach_details": {
"ach_trace_id": "ABC12300080",
"description": "PAYMENT",
"transaction_type_code": "PCR",
"return_code": null,
"return_code_label": null
},
"retry": null
}
],
"can_retry": false,
"can_refund": false,
"can_cancel": false,
"cancel_deadline": "2022-02-19T17:00:00.000Z",
"can_reverse": false,
"reversal_deadline": null,
"direction": "debit",
"company": "com_ENA4k8LMHbgpV07GLGSv"
}| Attribute | Description |
|---|---|
idstring | Unique identifier for the payment. |
statusstring | Status of the payment in its lifecycle. One of |
amountstring | The amount of the payment, expressed as a decimal. |
typestring | The type of payment. One of |
parent_typestring | The parent type of the payment One of |
parent_idstring | The id of the parent of the payment (refer to the An id can be one of |
payment_attemptsarray of objects | A list of associated attempts to fulfill the payment. Described in detail below. |
can_retryboolean | Boolean representing whether a particular payment can be retried. Two kinds of failed payments can be retried: a failed payment, which retries the payment to its original recipient, such as an employee or contractor, and a refund_failed payment, which retries the refund to the employer. See Retry a payment or refund. |
can_refundboolean | Boolean representing whether a particular payment can be refunded. Only credit payments in a failed state are eligible for refunds. A refund_failed payment whose employer refund was sent and then failed is not refundable; retry it instead. |
can_cancelboolean | Boolean representing whether a particular payment can be canceled with Cancel a payment. Employee and contractor net pay credits and balancing payroll collections and refunds can be canceled until Check transmits them. Other payments generally return false. |
cancel_deadlinedatetime | Datetime by which the payment can be canceled by. |
can_reverseboolean | Whether this payment can be reversed with Reverse a payment. Present for partners enrolled in the Corrections API preview; omitted otherwise. Only paid ACH credits for payroll items or contractor payments are eligible. |
reversal_deadlinedatetime, nullable | Last datetime by which the payment can be reversed. Present for partners enrolled in the Corrections API preview; omitted otherwise. |
directionstring | String describing the direction of the payment from the caller's perspective. Direction can be either |
companystring | Unique identifier for the company associated with this payment |
Objects in the payment_attempts array
| Attribute | Description |
|---|---|
idstring | Id of the payment attempt |
created_atdatetime | Datetime at which the payment attempt was created |
expected_completion_datedate | The date on which the payment is expected to settle. |
statusstring | Status of the payment attempt in its lifecycle. One of |
failure_codestring, nullable | A code describing the reason for a payment attempt failure. One of |
payment_methodstring | A field describing the method of which the payment attempt was executed. One of |
payment_instrumentstring | If relevant, the id of the corresponding instrument used to complete a payment attempt. When payment_method is set to ach, payment_instrument will be a bank account id |
wire_detailsobject | An object describing the relevant details to wire Check for a payment. Present if payment_method is set to wire or wire_drawdownNote: funds should not be manually wired to the wire_detailson payrolls with wire_drawdown funded payrolls unless falling back after the original drawdown request has been explicitly been refused or timed_out. |
ach_detailsobject | An object describing the relevant details regarding an ACH payment. Present if payment_method is set to ach |
retry | Field indicating whether the PaymentAttempt is a retry. Can be one of
|
The wire_details object
| Attribute | Description |
|---|---|
account_numberstring | Account number for a Check-controlled bank account for wiring purposes |
routing_numberstring | Routing number used for wiring purposes. |
bank_namestring | Name of the bank used for wiring purposes. |
account_namestring | Name of the bank account used for wiring purposes. |
account_addressstring | Address of the bank account used for wiring purposes. |
amountnumber | Decimal-quoted amount of money to wire Check. |
The ach_details object
| Attribute | Description |
|---|---|
ach_trace_idstring | Trace ID associated with Payment Attempt. Present after attempt is processed if payment_method = ach |
descriptionstring | Human-friendly description of Payment |
transaction_type_codestring | Arbitrary descriptive codes that will show up alongside the transaction in the receivers bank statement. Please see our glossary of these codes for more information. |
return_codestring | The return code stored when the ACH entry was returned. This is normally the NACHA code the receiving bank sent, such as R01. null when the payment attempt has not been returned, or when the return carried no code. Branch on failure_code rather than this field. |
return_code_labelstring | A human-readable label for return_code, using Check's version of the NACHA return code titles. null whenever return_code is null, and for a return code Check has no description for. |

