Pular para o conteúdo principal
POST
/
projects
Criar um projeto
curl --request POST \
  --url https://api.pague.dev/v1/projects \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "name": "Minha Loja",
  "color": "#3B82F6",
  "description": "Loja virtual de eletrônicos",
  "logoUrl": "https://example.com/logo.png"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Minha Loja",
  "color": "#3B82F6",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "Loja virtual de eletrônicos",
  "logoUrl": "https://example.com/logo.png"
}

Cabeçalhos

X-API-Key
string
obrigatório

Chave de API de integração (pd_live_* para produção, pd_test_* para sandbox)

Corpo

application/json
name
string
obrigatório

Nome do projeto

Maximum string length: 255
Exemplo:

"Minha Loja"

color
string
obrigatório

Cor do projeto em formato hexadecimal

Exemplo:

"#3B82F6"

description
string

Descrição do projeto

Exemplo:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

URL do logo do projeto

Exemplo:

"https://example.com/logo.png"

Resposta

Projeto criado com sucesso

id
string<uuid>
obrigatório

ID do projeto

name
string
obrigatório

Nome do projeto

Exemplo:

"Minha Loja"

color
string
obrigatório

Cor do projeto em formato hexadecimal

Exemplo:

"#3B82F6"

createdAt
string<date-time>
obrigatório

Data de criação

description
string

Descrição do projeto

Exemplo:

"Loja virtual de eletrônicos"

logoUrl
string<uri>

URL do logo do projeto

Exemplo:

"https://example.com/logo.png"