Project structure

Structure

The store represents the project associated with your API key:

{
  "id": "clz9x8w7v6u5t4s3r2q1",
  "name": "Minha Loja",
  "devMode": false,
  "pixExpirationMinutes": 60,
  "maxTransactionAmountCents": null
}

Attributes

string

Unique identifier of the project in CUID format.

string

Project name configured in the Dashboard.

boolean

Indicates whether the project is in sandbox mode (true) or production (false). Reflects the environment of the API key used (sk_test_* or sk_live_*).

integer

Time in minutes until a PIX charge expires. Configurable in the Dashboard.

integer | null

Maximum amount allowed per transaction, in cents. null indicates that no limit is configured.

Next steps

Store data

Check the project’s settings via the API.

Authentication

The API key determines which project the request belongs to.

Store dataRetorna os detalhes da loja associados à API Key autenticada.

Transactions

Checkout

Customers

Project

Sandbox

Structure

Attributes

Next steps

Store data

Authentication

​Structure

​Attributes

​Next steps

Store data

Authentication

Structure

Attributes

Next steps