CHcheckhq

List payments

Changed on
get/payments

Request

Query parameters

payrollstring

Return all payments, including debits and credits, related to a particular payroll ID

payroll_itemstring

Return payments related to a particular parent payroll_item ID

contractor_paymentstring

Return payments related to a particular parent contractor payment ID

parent_idstring

Return payments whose parent_id matches the given value. Repeat the parameter to match any of multiple parent IDs (OR), for example ?parent_id=pay_abc&parent_id=cor_def. Values are matched against the parent_id returned on payment responses, including correction IDs (cor_...) when a correction is the parent. At most 100 values are allowed per request.

companystring

Return payments related to a particular company ID

direction'credit' | 'debit'

Return payments with direction

amount_minstring

Return payments where amount ≥ an amount

amount_maxstring

Return payments where amount ≤ an amount

type'company_cash_requirement' | 'employee_net_pay' | 'net_pay_refund' | 'collection' | 'refund'

Return payments with type

completion_date_afterstring date

Return payments whose expected completion date is on or after the specified date

completion_date_beforestring date

Return payments whose expected completion date is on or before the specified date

limitinteger

Number of payments returned per page. The maximum value is 100.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

Response

200

nextunknown
previousunknown

Example response

{
  "results": [
    {
      "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",
          "payment_method": "ach",
          "payment_instrument": "bnk_W7hjDGn6sU1d3U8dr9bq",
          "ach_details": {
            "ach_trace_id": "ABC12300080",
            "description": "PAYMENT",
            "transaction_type_code": "PCR"
          }
        }
      ],
      "cancel_deadline": "2022-02-19T17:00:00.000Z",
      "direction": "debit",
      "company": "com_ENA4k8LMHbgpV07GLGSv",
      "reversal_deadline": "2022-02-24T01:00:00.000Z"
    }
  ]
}

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter parent_id

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status