The payments and payment attempts objects

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_vIFHhvyGN47ej1upyIT8",
    "status": "paid",
    "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": "paid",
            "failure_code": null,
            "payment_method": "ach",
            "payment_instrument": "bnk_GaeJoEAzbqqc2D9GMfOF",
            "wire_details": null
        },
    ],
    "can_retry": false,
    "can_refund": false,
    "direction": "debit"
}
AttributeDescription
id
string
Unique identifier for the payment.
status
string
Status of the payment in its lifecycle.

One of draft, processing, paid, failed, or refunded
amount
string
The amount of the payment, expressed as a decimal.
type
string
The type of payment.

One of company_cash_requirement or employee_net_pay
parent_type
string
The parent type of the payment

One of payroll, payroll_item, or contractor_payment
parent_id
string
The id of the parent of the payment (refer to the parent_type field for the potential parents).

An id can be one of pay_..., pyi_..., or cpa_...
payment_attempts
array of objects
A list of associated attempts to fulfill the payment. Described in detail below.
can_retry
boolean
Boolean representing whether a particular payment can be retried. A payment must be in a failed state to be eligible for retry.
can_refund
boolean
Boolean representing whether a particular payment can be refunded. Only credit payments in a failed state are eligible for refunds.
direction
string
String describing the direction of the payment from the caller's perspective.

Direction can be either credit or debit

Objects in the payment_attempts array

AttributeDescription
id
string
Id of the payment attempt
created_at
datetime
Datetime at which the payment attempt was created
expected_completion_date
date
The date on which the payment is expected to settle.
status
string
Status of the payment attempt in its lifecycle.

One of draft, processing, paid, failed, or refunded
failure_code
string
A code describing the reason for a payment attempt failure.

One of insufficient_funds, account_closed, invalid_account_number, debit_not_authorized, declined, could_not_process, account_frozen, or invalid_account_holder
payment_method
string
A field describing the method of which the payment attempt was executed.

One of ach, wire, or manual
payment_instrument
string
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_details
object
An object describing the relevant details to wire Check for a payment. Present if payment_method is set to wire

The wire_details object

AttributeDescription
account_number
string
Account number for a Check-controlled bank account for wiring purposes
routing_number
string
Routing number used for wiring purposes.
bank_name
string
Name of the bank used for wiring purposes.
account_name
string
Name of the bank account used for wiring purposes.
account_address
string
Address of the bank account used for wiring purposes.
amount
number
Decimal-quoted amount of money to wire Check.