---
title: "Add a new sandbox payment"
method: POST
path: "/sandbox/payment"
tags: ["Sandbox"]
---

# Add a new sandbox payment

`POST /sandbox/payment`

## Request body

- CreateSandboxPaymentRequest — Fields to configure the payment. Takes all fields from the `/payment` endpoint. All fields are optional.
  - `start_date` string, date
  - `end_date` string, date
  - `pay_statements` object[] — Array of pay statements to include in the payment.
    - `individual_id` string, uuid, required
    - `type` 'off_cycle_payroll' | 'one_time_payment' | 'regular_payroll' | 'null', nullable
    - `payment_method` 'check' | 'direct_deposit' | 'other' | 'null', nullable
    - `total_hours` number
    - `gross_pay` integer
    - `net_pay` integer
    - `earnings` object[]
      - `amount` integer
      - `hours` number
      - `name` string
      - `type` 'bonus' | 'commission' | 'double_overtime' | 'other' | 'overtime' | 'pto' | 'reimbursement' | 'salary' | 'severance' | 'sick' | 'tips' | 'wage' | '1099'
    - `taxes` object[]
      - `amount` integer
      - `name` string
      - `employer` boolean
      - `type` 'federal' | 'fica' | 'local' | 'state'
    - `employee_deductions` object[]
      - `amount` integer
      - `name` string — The deduction name. Required when type is specified.
      - `pre_tax` boolean
      - `type` '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira'
    - `employer_contributions` object[]
      - `amount` integer
      - `name` string — The contribution name. Required when type is specified.
      - `type` '457' | '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457_roth' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'fsa_dependent_care' | 'fsa_medical' | 'hsa_post' | 'hsa_pre' | 's125_dental' | 's125_medical' | 's125_vision' | 'simple' | 'simple_ira'

## Response `200`

OK

- PaymentIdentifiers
  - `payment_id` string, required — The ID of the payment.
  - `pay_date` string, required — The date of the payment.

---

[API](https://skmtc.net/finch-api/apis/api-reference.md) · [All operations](https://skmtc.net/finch-api/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finch-api/api-reference/revisions/f1cca2cb0ef2/schema)