Skip to main content
Um file representa um arquivo que você enviou para a Chargefy e que fica hospedado para ser referenciado por outros recursos — uma foto usada em product.image_url, o avatar exibido em listas e recibos, ou um documento anexado como evidência de disputa. Cada file guarda os metadados do arquivo (nome, tipo MIME, tamanho) e expõe uma url que aponta para o conteúdo hospedado. Ele surge quando você faz upload pela API e a purpose define como o arquivo é armazenado: arquivos públicos devolvem uma url permanente em storage.chargefy.io, enquanto arquivos privados devolvem uma URL assinada de curta validade, regenerada a cada leitura. O upload em si não vincula o arquivo a nenhum recurso — guardar a url no campo de destino é responsabilidade do recurso que vai referenciá-lo.

Data Object

Este é o formato completo retornado em create, get e itens de list.
string
Identificador do arquivo. Usa o prefixo file_*.
string
Sempre "file".
string
Data de criação em ISO 8601.
string
Nome do binário armazenado. Quando não foi informado no upload, parte do nome enviado; imagens preparadas pela Chargefy terminam em .webp.
boolean
true em produção; false em ambiente de teste.
object
Objeto livre para correlacionar o arquivo com o seu sistema. Quando vazio, retorna {}.
string
Tipo MIME do binário armazenado, como image/webp ou application/pdf. Imagens aceitas pela política retornam image/webp, mesmo quando a entrada era JPG, PNG, GIF, BMP, HEIC ou HEIF.
string
Define como o arquivo foi validado e armazenado.
integer
Tamanho do binário armazenado em bytes, depois da normalização quando for imagem.
string | null
Data da última atualização em ISO 8601. Vem null enquanto o arquivo nunca foi atualizado.
string | null
URL para acessar o binário hospedado. Permanente para arquivos públicos (organization_avatar, user_avatar, product_image, platform_avatar); assinada e de curta validade (1 hora) para arquivos privados (dispute_evidence, kyc_document), regenerada a cada get. Vem null quando a URL não pôde ser resolvida.

Operações