> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tilta.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve the platform
> Fetch the platform object for your authenticated integration, including your platform name, current status, and account-level configuration settings.
The platform object is the top-level representation of your integration with Tilta. Retrieve it to inspect account-level settings such as your supported currencies, payout term, and communication defaults. It also doubles as a connectivity check during integration: a successful response confirms your API key is valid and your platform is in good standing.
Account settings are configured during onboarding and cannot be changed through the API. To update them, contact your Tilta
account manager.
## OpenAPI
````yaml GET /v1/platform
openapi: 3.0.0
info:
version: 0.0.1
title: Tilta API
description: Tilta API documentation
servers:
- url: https://api.tilta.io
description: Tilta Production API
- url: https://api.tilta-sandbox.io
description: Tilta Sandbox API
security: []
paths:
/v1/platform:
get:
tags:
- Platforms
summary: Retrieve a platform
description: Returns a platform object.
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: The unique code of the platform.
name:
type: string
description: The name of the platform.
logo_url:
type: string
nullable: true
description: The URL of the platform logo.
redirect_url:
type: string
nullable: true
description: Redirect URL of the platform.
created_at:
type: number
description: The timestamp when the platform was created.
example: 1582896122
country:
type: string
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AQ
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BQ
- BA
- BW
- BV
- BR
- IO
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CX
- CC
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- CI
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FK
- FO
- FJ
- FI
- FR
- GF
- PF
- TF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HM
- VA
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- YT
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- 'NO'
- OM
- PK
- PW
- PS
- PA
- PG
- PY
- PE
- PH
- PN
- PL
- PT
- PR
- QA
- RO
- RU
- RW
- RE
- BL
- SH
- KN
- LC
- MF
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SJ
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TM
- TC
- TV
- TR
- UG
- UA
- AE
- GB
- UM
- US
- UY
- UZ
- VU
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
- AX
description: The country code of the platform.
currency:
type: string
enum:
- EUR
- GBP
- USD
- CHF
- PLN
- CZK
- RON
- BGN
- DKK
- HUF
- SEK
- NOK
- JPY
- AUD
- NZD
- CAD
description: The currency of the platform.
financing_currencies:
type: array
items:
type: string
enum:
- EUR
- GBP
- USD
- CHF
- PLN
- CZK
- RON
- BGN
- DKK
- HUF
- SEK
- NOK
- JPY
- AUD
- NZD
- CAD
description: Currencies enabled for financing requests on the platform.
collection_currencies:
type: array
items:
type: string
enum:
- EUR
- GBP
- USD
- CHF
- PLN
- CZK
- RON
- BGN
- DKK
- HUF
- SEK
- NOK
- JPY
- AUD
- NZD
- CAD
description: >-
Currencies enabled for collection requests on the
platform.
support_emails:
type: array
items:
type: string
format: email
description: >-
The support email addresses of the platform. Notifications
are sent to all of them.
payout_term:
type: number
description: The payout term of the platform.
max_payment_term:
type: number
description: The maximum payment term of the platform.
min_payout_business_day:
type: integer
nullable: true
minimum: 1
description: >-
Platform-specific override for the minimum number of
business days from today before which a payout date cannot
be scheduled. Defaults to 2 when not set. Must be at least
1.
is_single_merchant:
type: boolean
description: Indicates if the platform is a single merchant.
communication_email:
type: string
nullable: true
description: The communication email of the platform.
communication_bcc_email:
type: string
nullable: true
format: email
description: >-
Optional email address BCC-ed on all outgoing buyer
communication sent on behalf of the platform.
language:
type: string
nullable: true
enum:
- AR
- BG
- CS
- DA
- DE
- EL
- EN
- ES
- ET
- FI
- FR
- GA
- HR
- HU
- IT
- JA
- LT
- LV
- MT
- NL
- 'NO'
- PL
- PT
- RO
- RU
- SK
- SL
- SV
- TR
- UK
- ZH
description: The communication language of the platform.
formality:
type: string
enum:
- NEUTRAL
- FORMAL
- INFORMAL
description: >-
The communication formality of the platform. Neutral by
default.
has_erp_configuration:
type: boolean
description: Indicates whether the platform has an ERP configuration.
required:
- code
- name
- created_at
- country
- currency
- financing_currencies
- collection_currencies
- support_emails
- payout_term
- max_payment_term
- is_single_merchant
- language
- formality
- has_erp_configuration
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestSchema'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedRequestSchema'
'404':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/platformNotFoundSchema'
security:
- bearerAuth: []
components:
schemas:
badRequestSchema:
type: object
properties:
code:
type: string
description: Error code
example: BAD_REQUEST
error:
type: string
description: Error message for debugging purposes
example: Request validation failed. 1 issue found.
issues:
type: array
items:
type: object
properties:
code:
type: string
description: Issue code
example: INVALID_TYPE
path:
type: string
description: Issue path starting with body, params, querystring, or headers
example: body.registered_at
message:
type: string
description: Issue message for debugging purposes
example: Invalid type
required:
- code
- path
- message
description: List of issues
example:
- code: INVALID_TYPE
path: body.registered_at
message: Invalid type
required:
- code
- error
- issues
description: Bad Request, see error message for details.
example:
code: BAD_REQUEST
error: Request validation failed. 1 issue found.
issues:
- code: INVALID_TYPE
path: body.registered_at
message: Invalid type
unauthorizedRequestSchema:
type: object
properties:
error:
type: string
description: Error details.
example: Unauthorized
code:
type: string
description: Error code.
example: UNAUTHORIZED
required:
- error
- code
description: Unauthorized Request.
example:
error: Unauthorized
code: UNAUTHORIZED
platformNotFoundSchema:
type: object
properties:
error:
type: string
description: Error details.
example: No Entity found
code:
type: string
description: Error code.
example: NOT_FOUND
required:
- error
- code
description: Platform not found
example:
error: No Entity found
code: NOT_FOUND
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Your Tilta API key, sent as `Bearer `.
````