Bem-vindo à documentação técnica!

Nessa documentação, você vai encontrar todas as informações necessárias para integrar com as nossas APIs.

Padrões - Métodos POST

Alguns endpoints POST desta API não retornam o recurso criado no corpo da resposta. Em caso de sucesso, a API responde com HTTP 201 Created, corpo vazio e a URL do recurso no header Location.

Esse comportamento segue a recomendação do HTTP para criação de recursos: o servidor indica onde o recurso foi criado por meio do header Location, e o cliente usa essa URL para acessá-lo posteriormente.

O que a API retorna

Elemento	Valor
Status HTTP	`201 Created`
Corpo	Vazio (sem body)
Header	`Location`: URL absoluta do recurso criado

Como integrar

Trate pelo status
Considere que o recurso foi criado quando a resposta for 201; não espere dados no corpo.
Leia o header Location
A URL do recurso criado vem no header Location da resposta.
Obtenha os dados do recurso
Faça um GET na URL indicada em Location, usando o mesmo token de autenticação (Authorization).

Exemplo de fluxo

POST /api/v2/invoices
→ 201 Created
→ Location: https://api.exemplo.com/api/v2/invoices/12345

GET https://api.exemplo.com/api/v2/invoices/12345
→ 200 OK
→ { ... dados da cobrança ... }

Exemplo em pseudocódigo

resposta = POST /api/v2/... (body da requisição)

se resposta.status == 201:
    url_do_recurso = resposta.headers["Location"]
    recurso = GET url_do_recurso   # com o mesmo token de autenticação
    # usar recurso

Observações

O header Location contém sempre uma URL absoluta.
Em alguns endpoints podem existir outros headers úteis na resposta (por exemplo Link para PDF de boleto); verifique a documentação do endpoint.
Em caso de erro, a API retorna outros códigos de status (4xx/5xx) e, quando aplicável, corpo com detalhes do erro.