# Tilled API API

> Tilled API API on Apizie: 111 endpoints (Get an Account, Update an Account, Add an Account Capability, Update an Account Capability, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/finance:tilled/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `finance:tilled`
- Category: Finance
- Status: byok
- Source: https://tilled.com
- Page: https://apizie.tech/api/finance/tilled
- OpenAPI: https://apizie.tech/api/finance/tilled/openapi.json

The Tilled API is organized around [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer). Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded…

## Endpoints

### Get an Account
`GET https://apizie.tech/v1/finance:tilled/accounts-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### Update an Account
`POST https://apizie.tech/v1/finance:tilled/accounts-update-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Add an Account Capability
`POST https://apizie.tech/v1/finance:tilled/accounts-add-capability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Update an Account Capability
`POST https://apizie.tech/v1/finance:tilled/accounts-update-capability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Delete an Account Capability
`POST https://apizie.tech/v1/finance:tilled/accounts-remove-capability` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Connected Accounts
`GET https://apizie.tech/v1/finance:tilled/accounts-list-connected` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| q | string | no | The partial search of text fields. Supports searching by `account.name`, `account.business_profile.legal_name`, `account.id`,… |
| sort | string | no | The sort parameters, value:direction. Possible values: `name`, `created_at`. Possible directions: `asc`, `desc` For example `name:asc`.… |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Connected Account
`POST https://apizie.tech/v1/finance:tilled/accounts-create-connected-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Delete a Connected Account
`POST https://apizie.tech/v1/finance:tilled/accounts-delete-merchant-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### List all API Keys
`GET https://apizie.tech/v1/finance:tilled/api-keys-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create an API key
`POST https://apizie.tech/v1/finance:tilled/api-keys-create-new-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Update an API key
`POST https://apizie.tech/v1/finance:tilled/api-keys-update-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Delete an API Key
`POST https://apizie.tech/v1/finance:tilled/api-keys-permanently-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Apple Pay Domains
`GET https://apizie.tech/v1/finance:tilled/apple-pay-domains-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### Create an Apple Pay Domain
`POST https://apizie.tech/v1/finance:tilled/apple-pay-domains-create-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get an Apple Pay Domain
`GET https://apizie.tech/v1/finance:tilled/apple-pay-domains-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### Delete an Apple Pay Domain
`POST https://apizie.tech/v1/finance:tilled/apple-pay-domains-delete-domain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### Get a Merchant Application
`GET https://apizie.tech/v1/finance:tilled/onboarding-get-merchant-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The id of the associated connected (i.e. merchant) account. |

### Update a Merchant Application
`POST https://apizie.tech/v1/finance:tilled/onboarding-update-merchant-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The id of the associated connected (i.e. merchant) account. |
| body | object | yes | JSON request body |

### Submit a Merchant Application
`POST https://apizie.tech/v1/finance:tilled/onboarding-submit-merchant-application` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | yes | The id of the associated connected (i.e. merchant) account. |

### Create an Auth Link
`POST https://apizie.tech/v1/finance:tilled/auth-links-create-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Forgot Password
`POST https://apizie.tech/v1/finance:tilled/users-request-password-reset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Login
`POST https://apizie.tech/v1/finance:tilled/users-create-jwt-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Logout
`POST https://apizie.tech/v1/finance:tilled/users-invalidate-refresh-token` (byok)

### Refresh an Access Token
`POST https://apizie.tech/v1/finance:tilled/users-refresh-access-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Register
`POST https://apizie.tech/v1/finance:tilled/users-register-user-and-partner-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Reset Password
`POST https://apizie.tech/v1/finance:tilled/users-reset-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List all Balance Transactions
`GET https://apizie.tech/v1/finance:tilled/balance-transactions-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). |
| type | string | no | Only return transaction of the given type. |
| source_id | string | no | Only returns the original transaction. |
| payout_id | string | no | Only returns transactions that were paid out on the specified payout ID. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Get a Balance Transactions Summary
`GET https://apizie.tech/v1/finance:tilled/balance-transactions-get-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| time_unit | string | no | String indicating the unit of time to aggregate the summary of data. |
| time_zone | string | no | Time Zone by which to aggregate the results. |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). Defaults to the beginning of the current month. |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). Defaults to midnight tonight. |
| types | array | no | An array containing specific balance transaction types. The data will be filtered to include only transactions with a matching type… |
| include_connected_accounts | boolean | no | Whether or not to include the results from any connected accounts. |

### Get a Balance Transaction
`GET https://apizie.tech/v1/finance:tilled/balance-transactions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Get a Charge
`GET https://apizie.tech/v1/finance:tilled/charges-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Checkout Sessions
`GET https://apizie.tech/v1/finance:tilled/checkout-sessions-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| payment_intent_id | string | no | Only return the checkout session for the payment intent specified. |
| customer_id | string | no | Only return the checkout session for the customer specified. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Checkout Session
`POST https://apizie.tech/v1/finance:tilled/checkout-sessions-create-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Checkout Session
`GET https://apizie.tech/v1/finance:tilled/checkout-sessions-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Expire a Checkout Session
`POST https://apizie.tech/v1/finance:tilled/checkout-sessions-expire-session` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Customers
`GET https://apizie.tech/v1/finance:tilled/customers-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| q | string | no | The partial search of text fields. Supports searching by `customer.first_name`, `customer.last_name`, `customer.email`, `customer.phone` |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Customer
`POST https://apizie.tech/v1/finance:tilled/customers-create-customer-object` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Customer
`GET https://apizie.tech/v1/finance:tilled/customers-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Update a Customer
`POST https://apizie.tech/v1/finance:tilled/customers-update-customer-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Delete a Customer
`POST https://apizie.tech/v1/finance:tilled/customers-delete-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Disputes
`GET https://apizie.tech/v1/finance:tilled/disputes-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| charge_id | string | no | Only returns disputes for the charge specified by this charge ID. |
| include_connected_accounts | boolean | no | Whether or not to include the results from any connected accounts. |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). |
| status | array | no | String indicating the status to filter the result by. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Get a Dispute
`GET https://apizie.tech/v1/finance:tilled/disputes-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Create Dispute Evidence
`POST https://apizie.tech/v1/finance:tilled/disputes-submit-evidence` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### List all Documents
`GET https://apizie.tech/v1/finance:tilled/documents-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| status | string | no |  |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Bulk Submit Documents
`POST https://apizie.tech/v1/finance:tilled/documents-bulk-submit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Document
`GET https://apizie.tech/v1/finance:tilled/documents-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes | The id of the document to be retrieved. |

### Submit a Document
`POST https://apizie.tech/v1/finance:tilled/documents-submit-document` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes | The id of the document to be updated. |
| body | object | yes | JSON request body |

### List all Events
`GET https://apizie.tech/v1/finance:tilled/events-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). |
| types | array | no | An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event… |
| object_id | string | no | Id of related resource. The list will be filtered to include events that are related to the resource with this id. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Get an Event
`GET https://apizie.tech/v1/finance:tilled/events-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Files
`GET https://apizie.tech/v1/finance:tilled/files-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| purposes | array | no | A list of file purposes to filter on. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a File
`POST https://apizie.tech/v1/finance:tilled/files-upload-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | Form fields as a JSON object |

### Get a File
`GET https://apizie.tech/v1/finance:tilled/files-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Delete a File
`POST https://apizie.tech/v1/finance:tilled/files-permanently-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Get the Contents of a File
`GET https://apizie.tech/v1/finance:tilled/files-get-contents-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Get the Overall Health of the API
`GET https://apizie.tech/v1/finance:tilled/health-overall-status` (byok)

### List all Outbound Transfers
`GET https://apizie.tech/v1/finance:tilled/outbound-transfers-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| status | array | no | Only return OutboundTransfers whose status is included by this array. Example: `/v1/outbound-transfers?status=succeeded` |
| include_connected_accounts | boolean | no | Whether or not to include the results from any connected accounts. |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create an Outbound Transfer
`POST https://apizie.tech/v1/finance:tilled/outbound-transfers-create-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get an Outbound Transfer
`GET https://apizie.tech/v1/finance:tilled/outbound-transfers-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Cancel an Outbound Transfer
`POST https://apizie.tech/v1/finance:tilled/outbound-transfers-cancel-transfer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Payment Intents
`GET https://apizie.tech/v1/finance:tilled/payment-intents-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). |
| status | array | no | Only return PaymentIntents whose status is included by this array. Examples:… |
| include_connected_accounts | boolean | no | Whether or not to include the results from any connected accounts. |
| subscription_id | string | no | The ID of the subscription whose payment intents will be retrieved. |
| q | string | no | Supports searching by `payment_intent.id`, `payment_intent.amount`, `payment_method.billing_details.name`, `payment_method.details.last4`,… |
| customer_id | string | no | The ID of the customer whose payment intents will be retrieved. |
| terminal_reader_id | string | no | The ID of the terminal reader for which payment intents will be retrieved. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Payment Intent
`POST https://apizie.tech/v1/finance:tilled/payment-intents-create-payment-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Payment Intent
`GET https://apizie.tech/v1/finance:tilled/payment-intents-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Update a Payment Intent
`POST https://apizie.tech/v1/finance:tilled/payment-intents-update-without-confirmation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Cancel a Payment Intent
`POST https://apizie.tech/v1/finance:tilled/payment-intents-cancel-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Capture a Payment Intent
`POST https://apizie.tech/v1/finance:tilled/payment-intents-capture-funds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Confirm a Payment Intent
`POST https://apizie.tech/v1/finance:tilled/payment-intents-confirm-intent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### List a Customer's Payment Methods
`GET https://apizie.tech/v1/finance:tilled/payment-methods-list-for-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| type | string | yes | Only return payment methods of the given type. |
| customer_id | string | yes | Customer identifier |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Payment Method
`POST https://apizie.tech/v1/finance:tilled/payment-methods-create-new-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Payment Method
`GET https://apizie.tech/v1/finance:tilled/payment-methods-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Update a Payment Method
`POST https://apizie.tech/v1/finance:tilled/payment-methods-update-method` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Attach a Payment Method to a Customer
`POST https://apizie.tech/v1/finance:tilled/payment-methods-attach-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Detach a Payment Method from a Customer
`POST https://apizie.tech/v1/finance:tilled/payment-methods-detach-method-from-customer` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Payouts
`GET https://apizie.tech/v1/finance:tilled/payouts-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). Cannot be paired with paid_at_gte or paid_at_lte. |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). Cannot be paired with paid_at_gte or paid_at_lte. |
| paid_at_gte | string | no | Minimum `paid_at` value to filter by (inclusive). Cannot be paired with created_at_gte or created_at_lte. |
| paid_at_lte | string | no | Maximum `paid_at` value to filter by (inclusive). Cannot be paired with created_at_gte or created_at_lte. |
| status | string | no | Only return payouts that have the given status. |
| include | string | no | An array of optional include parameters, specifying extra properties to return. Currently for this endpoint only accepts… |
| include_connected_accounts | boolean | no | Whether or not to include the results from any connected accounts. |
| q | string | no | Supports searching by `payouts.id`, `payouts.amount` |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Get a Payout
`GET https://apizie.tech/v1/finance:tilled/payouts-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| include | array | no | An array of optional include parameters, specifying extra properties to return. Currently for this endpoint only accepts… |

### List all Platform Fees
`GET https://apizie.tech/v1/finance:tilled/platform-fees-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). |
| charge_id | string | no | Only return application fees for the charge specified by this charge id. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Get a Platform Fee
`GET https://apizie.tech/v1/finance:tilled/platform-fees-get-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Get a Platform Fee Refund
`GET https://apizie.tech/v1/finance:tilled/platform-fee-refunds-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| refund_id | string | yes |  |

### List all Pricing Templates
`GET https://apizie.tech/v1/finance:tilled/pricing-templates-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| type | string | no | String indicating the type to filter the result by. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Get a Pricing Template
`GET https://apizie.tech/v1/finance:tilled/pricing-templates-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Refunds
`GET https://apizie.tech/v1/finance:tilled/refunds-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Refund
`POST https://apizie.tech/v1/finance:tilled/refunds-create-new-refund` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Refund
`GET https://apizie.tech/v1/finance:tilled/refunds-get-details-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Report Runs
`GET https://apizie.tech/v1/finance:tilled/report-runs-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| type | array | no | Only return ReportRuns whose type is included by this array. Examples: `?type=payments_summary_1,payouts_summary_2` and… |
| status | array | no | Only return ReportRuns whose status is included by this array. Examples: `?status=finished` and `?status=finished,queued`. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Report Run
`POST https://apizie.tech/v1/finance:tilled/report-runs-create-run` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Report Run
`GET https://apizie.tech/v1/finance:tilled/report-runs-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Subscriptions
`GET https://apizie.tech/v1/finance:tilled/subscriptions-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| customer_id | string | no | The ID of the customer whose subscriptions will be retrieved. |
| status | string | no | The status of the subscriptions to retrieve. |
| next_payment_at_lte | string | no | Maximum `next_payment_at` value to filter by (inclusive). |
| next_payment_at_gte | string | no | Minimum `next_payment_at` value to filter by (inclusive). |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Subscription
`POST https://apizie.tech/v1/finance:tilled/subscriptions-create-new-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Subscription
`GET https://apizie.tech/v1/finance:tilled/subscriptions-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Update a Subscription
`POST https://apizie.tech/v1/finance:tilled/subscriptions-update-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Cancel a Subscription
`POST https://apizie.tech/v1/finance:tilled/subscriptions-cancel-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Pause a Subscription
`POST https://apizie.tech/v1/finance:tilled/subscriptions-pause-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Resume a Subscription
`POST https://apizie.tech/v1/finance:tilled/subscriptions-resume-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Retry a Subscription
`POST https://apizie.tech/v1/finance:tilled/subscriptions-retry-payment-at` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### List all Terminal Readers
`GET https://apizie.tech/v1/finance:tilled/terminal-readers-list-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| metadata | object | no | `metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example:… |
| q | string | no | The partial search of text fields. Supports searching by `terminal_reader.description`, `terminal_reader.serial_number`,… |
| include_connected_accounts | boolean | no | Whether or not to include the results from any connected accounts. |
| created_at_gte | string | no | Minimum `created_at` value to filter by (inclusive). |
| created_at_lte | string | no | Maximum `created_at` value to filter by (inclusive). |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Get a Terminal Reader
`GET https://apizie.tech/v1/finance:tilled/terminal-readers-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Update a Terminal Reader
`POST https://apizie.tech/v1/finance:tilled/terminal-readers-update-reader` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Get a Terminal Reader status
`GET https://apizie.tech/v1/finance:tilled/terminal-readers-get-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all User Invitations
`GET https://apizie.tech/v1/finance:tilled/users-list-all-user-invitations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### Create a User Invitation
`POST https://apizie.tech/v1/finance:tilled/users-send-invitation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Check a User Invitation
`GET https://apizie.tech/v1/finance:tilled/users-check-user-invitation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |

### Get a User Invitation
`GET https://apizie.tech/v1/finance:tilled/users-get-invitation-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### Delete a User Invitation
`POST https://apizie.tech/v1/finance:tilled/users-delete-user-invitation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### Resend a User Invitation
`POST https://apizie.tech/v1/finance:tilled/users-resend-invitation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes |  |
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |

### List all Users
`GET https://apizie.tech/v1/finance:tilled/users-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| include_connected_accounts | boolean | no | Whether or not to include the results from any connected accounts. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Get a User
`GET https://apizie.tech/v1/finance:tilled/users-get-user-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Update a User
`POST https://apizie.tech/v1/finance:tilled/users-update-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Delete a User
`POST https://apizie.tech/v1/finance:tilled/users-remove-user` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### List all Webhook Endpoints
`GET https://apizie.tech/v1/finance:tilled/webhook-endpoints-get-all` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| offset | number | no | The (zero-based) offset of the first item in the collection to return. |
| limit | number | no | The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used. |

### Create a Webhook Endpoint
`POST https://apizie.tech/v1/finance:tilled/webhook-endpoints-create-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| body | object | yes | JSON request body |

### Get a Webhook Endpoint
`GET https://apizie.tech/v1/finance:tilled/webhook-endpoints-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

### Update a Webhook Endpoint
`POST https://apizie.tech/v1/finance:tilled/webhook-endpoints-update-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |
| body | object | yes | JSON request body |

### Delete a Webhook Endpoint
`POST https://apizie.tech/v1/finance:tilled/webhook-endpoints-delete-endpoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tilled-account | string | yes | The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of. |
| id | string | yes |  |

## Example
```
curl "https://apizie.tech/v1/finance:tilled/accounts-get-details" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Tilled API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/finance:tilled/accounts-get-details with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Tilled API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Tilled API itself also needs your own key from api.tilled.com.

### Can AI agents use the Tilled API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key finance:tilled.

### What is the status of the Tilled API API?
Needs your own provider key (bring your own key)