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

# Add a new sandbox payment

`POST /sandbox/payment`

## Request body

- object — Fields to configure the payment. Takes all fields from the `/payment` endpoint. All fields are optional.
  - `start_date` string
  - `end_date` string
  - `pay_statements` PayStatement[]
    - `individual_id` string — A stable Finch `id` (UUID v4) for an individual in the company
    - `type` 'regular_payroll' | 'off_cycle_payroll' | 'one_time_payment' | 'null', nullable — The type of the payment associated with the pay statement.
    - `payment_method` 'check' | 'direct_deposit' | 'null', nullable — The payment method.
    - `total_hours` number, nullable — The number of hours worked for this pay period
    - `gross_pay` Money, nullable
      - `amount` integer, nullable — Amount for money object (in cents)
      - `currency` string
    - `net_pay` Money, nullable
      - `amount` integer, nullable — Amount for money object (in cents)
      - `currency` string
    - `earnings` object[], nullable — The array of earnings objects associated with this pay statement
      - `type` 'salary' | 'wage' | 'reimbursement' | 'overtime' | 'severance' | 'double_overtime' | 'pto' | 'sick' | 'bonus' | 'commission' | 'tips' | '1099' | 'other' | 'null', nullable — The type of earning.
      - `name` string, nullable — The exact name of the deduction from the pay statement.
      - `amount` integer, nullable — The earnings amount in cents.
      - `currency` string, nullable — The earnings currency code.
      - `hours` number, nullable — The number of hours associated with this earning. (For salaried employees, this could be hours per pay period, `0` or `null`, depending on the provider).
      - `attributes` Metadata
        - `metadata` object — The metadata to be attached to the entity by existing rules. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).
    - `taxes` object[], nullable — The array of taxes objects associated with this pay statement.
      - `type` 'state' | 'federal' | 'local' | 'fica' | 'null', nullable — The type of taxes.
      - `name` string, nullable — The exact name of tax from the pay statement.
      - `employer` boolean, nullable — `true` if the amount is paid by the employers.
      - `amount` integer, nullable — The tax amount in cents.
      - `currency` string, nullable — The currency code.
      - `attributes` Metadata
        - `metadata` object — The metadata to be attached to the entity by existing rules. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).
    - `employee_deductions` object[], nullable — The array of deductions objects associated with this pay statement.
      - `name` string, nullable — The deduction name from the pay statement.
      - `amount` integer, nullable — The deduction amount in cents.
      - `currency` string, nullable — The deduction currency.
      - `pre_tax` boolean, nullable — Boolean indicating if the deduction is pre-tax.
      - `type` '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457' | '457_roth' | 's125_medical' | 's125_dental' | 's125_vision' | 'hsa_pre' | 'hsa_post' | 'fsa_medical' | 'fsa_dependent_care' | 'simple_ira' | 'simple' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'null', nullable — Type of benefit.
      - `attributes` Metadata
        - `metadata` object — The metadata to be attached to the entity by existing rules. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).
    - `employer_contributions` object[], nullable
      - `name` string, nullable — The contribution name from the pay statement.
      - `amount` integer, nullable — The contribution amount in cents.
      - `currency` string, nullable — The contribution currency.
      - `type` '401k' | '401k_roth' | '401k_loan' | '403b' | '403b_roth' | '457' | '457_roth' | 's125_medical' | 's125_dental' | 's125_vision' | 'hsa_pre' | 'hsa_post' | 'fsa_medical' | 'fsa_dependent_care' | 'simple_ira' | 'simple' | 'commuter' | 'custom_post_tax' | 'custom_pre_tax' | 'null', nullable — Type of benefit.
      - `attributes` Metadata
        - `metadata` object — The metadata to be attached to the entity by existing rules. It is a key-value pairs where the values can be of any type (string, number, boolean, object, array, etc.).

## Response `200`

OK

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

## Changes

- **2025-02-25** `5d2b3a9cdbcf` — 4 info
  - added the new optional request property `pay_statements/items/earnings/items/attributes`
  - added the new optional request property `pay_statements/items/employee_deductions/items/attributes`
  - added the new optional request property `pay_statements/items/employer_contributions/items/attributes`
  - added the new optional request property `pay_statements/items/taxes/items/attributes`

[Change history](https://skmtc.dev/finch-api/apis/api-reference/changes/sandbox/payment/post.md)

---

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