Skip to main content
GET
Retrieve a platform
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.

Authorizations

Authorization
string
header
required

Your Tilta API key, sent as Bearer <key>.

Response

code
string
required

The unique code of the platform.

name
string
required

The name of the platform.

created_at
number
required

The timestamp when the platform was created.

Example:

1582896122

country
enum<string>
required

The country code of the platform.

Available options:
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
currency
enum<string>
required

The currency of the platform.

Available options:
EUR,
GBP,
USD,
CHF,
PLN,
CZK,
RON,
BGN,
DKK,
HUF,
SEK,
NOK,
JPY,
AUD,
NZD,
CAD
financing_currencies
enum<string>[]
required

Currencies enabled for financing requests on the platform.

Available options:
EUR,
GBP,
USD,
CHF,
PLN,
CZK,
RON,
BGN,
DKK,
HUF,
SEK,
NOK,
JPY,
AUD,
NZD,
CAD
collection_currencies
enum<string>[]
required

Currencies enabled for collection requests on the platform.

Available options:
EUR,
GBP,
USD,
CHF,
PLN,
CZK,
RON,
BGN,
DKK,
HUF,
SEK,
NOK,
JPY,
AUD,
NZD,
CAD
support_emails
string<email>[]
required

The support email addresses of the platform. Notifications are sent to all of them.

payout_term
number
required

The payout term of the platform.

max_payment_term
number
required

The maximum payment term of the platform.

is_single_merchant
boolean
required

Indicates if the platform is a single merchant.

language
enum<string> | null
required

The communication language of the platform.

Available options:
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
formality
enum<string>
required

The communication formality of the platform. Neutral by default.

Available options:
NEUTRAL,
FORMAL,
INFORMAL
has_erp_configuration
boolean
required

Indicates whether the platform has an ERP configuration.

logo_url
string | null

The URL of the platform logo.

redirect_url
string | null

Redirect URL of the platform.

min_payout_business_day
integer | null

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.

Required range: x >= 1
communication_email
string | null

The communication email of the platform.

communication_bcc_email
string<email> | null

Optional email address BCC-ed on all outgoing buyer communication sent on behalf of the platform.