Skip to content

Tax Refund Method Resource

Resource representing how a tax refund should be delivered.

A tax refund method specifies how a tax refund should be delivered to a client. There are two types of refund methods:

  • Personal refund methods for individual tax returns
  • Business refund methods for business tax returns

Each refund method specifies a delivery method, which can be:

  • Direct deposit to a bank account
  • Physical check delivery
  • Future tax credit (business refunds only)

Endpoints

MethodUrl
GET/v1.0/tax-refund-methods/:id
GET/v1.0/jobs/:job_id/personal-refund-method
GET/v1.0/jobs/:job_id/business-refund-method
POST/v1.0/users/:user_id/tax-refund-methods
POST/v1.0/tax-refund-methods/:id
POST/v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-personal-refund-method
POST/v1.0/jobs/:job_id/checklist/:supporting_item_id/provide-business-refund-method

Properties

id
string

Unique identifier for the tax refund method.

version
integer

Version number of the tax refund method. Increments with each update.

owner_user_id
string

ID of the user that owns this tax refund method.

create_time
string

ISO 8601 timestamp of when the tax refund method was created.

update_time
string

ISO 8601 timestamp of when the tax refund method was last updated.

refund_type
string
required

Type of tax refund. Must be one of:

  • PERSONAL - For individual tax returns
  • BUSINESS - For business tax returns
delivery_method
object
required

Specification for how the refund should be delivered. Must contain exactly one of these properties:

Copied
1{
2 "id": "550e8400-e29b-41d4-a716-446655440000",
3 "version": 1,
4 "owner_user_id": "a385a314-12f9-4ee3-a838-c8785d5db610",
5 "create_time": "2024-01-01T12:00:00Z",
6 "update_time": "2024-01-01T12:00:00Z",
7 "refund_type": "PERSONAL",
8 "delivery_method": {
9 "direct_deposit": {
10 "bank_account": {
11 "account_type": "CHECKING",
12 "routing_number": "123456789",
13 "account_number": "987654321"
14 }
15 }
16 }
17}

Direct deposit

bank_account
object
required

Bank account details for direct deposit:

account_type
string
required

Type of bank account. Must be one of:

  • CHECKING
  • SAVINGS
routing_number
string
required

Bank routing number.

account_number
string
required

Bank account number.

Check

mailing_address
object

Optional physical address where the check should be mailed. If not provided, the address from the client's personal or business profile will be used.

Future tax credit

Empty object indicating the refund should be applied to future taxes. Only available for business refunds.

Physical address

address_line_1
string

First line of the address.

address_line_2
string

Second line of the address.

city
string

City name.

region
string

Region (state/province/territory).

postal_code
string

Postal code.

country
string

Country.

Last updated on November 1, 2024