This endpoint retrieves a paginated list of all tax refund methods associated with a specific user. The methods are returned in descending order by creation time. Delisted methods are excluded by default.

Endpoint

Method	Url
`GET`	`/v1.0/users/:user_id/tax-refund-methods`

Path Parameters

user_id

•

string

required

The unique identifier of the user whose tax refund methods are being retrieved.

Query Parameters

filter

•

string

The filter string. See the Filtering section for details on tax refund method filtering. Additionally, check the filtering documentation for more information.

page_size

•

integer

The number of items to return per page. Default is 200, maximum is 1000.

page_token

•

string

Token for retrieving the next page of results. Obtained from the next_page_token field in the previous response.

Sample Request

bashCopied
1curl -X GET 'https://api.worklayer.com/v1.0/users/550e8400-e29b-41d4-a716-446655440000/tax-refund-methods' \
2-H 'Authorization: Bearer {token}'

Response

data

•

list

Array of tax refund method resources.

total_size

•

integer

Total number of tax refund methods for this user across all pages.

next_page_token

•

string

Token to retrieve the next page of results. If not present, there are no more pages.

Sample Response

jsonCopied
1{
2  "data": [
3    {
4      "id": "550e8400-e29b-41d4-a716-446655440000",
5      "version": 1,
6      "owner_user_id": "a385a314-12f9-4ee3-a838-c8785d5db610",
7      "create_time": "2024-01-01T12:00:00Z",
8      "update_time": "2024-01-01T12:00:00Z",
9      "refund_type": "PERSONAL",
10      "delivery_method": {
11        "direct_deposit": {
12          "bank_account": {
13            "account_type": "CHECKING",
14            "routing_number": "123456789",
15            "account_number": "987654321"
16          }
17        }
18      }
19    },
20    {
21      "id": "7d8e9f10-2c3b-4a5c-6d7e-8f9a0b1c2d3e",
22      "version": 2,
23      "owner_user_id": "a385a314-12f9-4ee3-a838-c8785d5db610",
24      "create_time": "2024-02-15T10:00:00Z",
25      "update_time": "2024-03-20T16:45:00Z",
26      "refund_type": "BUSINESS",
27      "delivery_method": {
28        "future_tax_credit": {}
29      }
30    }
31  ],
32  "total_size": 2
33}

Filtering

The following fields are supported:

Field	Comparators	Description	Example
`refund_type`	`=`, `!=`	The refund type. Valid values are `PERSONAL` and `BUSINESS`.	`refund_type = PERSONAL`

Sample Request with Filter

bashCopied
1curl -X GET 'https://api.worklayer.com/v1.0/users/550e8400-e29b-41d4-a716-446655440000/tax-refund-methods?filter=refund_type=BUSINESS' \
2-H 'Authorization: Bearer {token}'

Errors

400: Invalid request parameters or filter format
403: You're not allowed to list tax refund methods for this user

Next steps

Last updated on June 19, 2025