Customizar o visual dos links de pagamentos

Definindo os padrões visuais dos links de pagamentos

A customização do link permite que cada cliente (cada conta) defina:

  • Logo (svg, jpg ou png com até 2mb)
  • Cor primária (hexadecimal, ex #7664FA)
  • Cor secundária (hexadecimal, ex #FFFFFF)
  • Raio da borda do sistema (arredondamento dos botões e caixas de diálogo, número inteiro entre 0 e 30, sendo 0 para bordas quadradas e 30 para bordas totalmente arredondadas)

Todas as cobranças são geradas com o domínio escolhido pelo dono do arranjo no BaaS (ex: sumarca.celcoin.app.br).

Além disso, é possível que o dono do arranjo determine um logo, cor e arredondamento dos botões únicos, ou seja, que iniba que cada cliente faça suas customizações, levando para todo o arranjo uma mesma configuração.

Cada cobrança manterá sempre o padrão visual estabelecido no momento da sua geração, ou seja, uma vez alterados os itens de customização, as próximas cobranças seguirão as definições estabelecidas. No entanto, cobranças geradas anteriormente não seguirão o novo padrão e manterão as configuração existentes anteriormente.

As configurações podem ser feitas via portal ou utilizando um endpoint específico para isso, o PUT Customizar link.

Na requisição da **API **, não é necessário informar todos os parâmetros.

Apenas os parâmetros informados serão atualizados, ficando os demais mantidos.

O logo deve estar disponível na URL no momento da requisição de alteração do visual e passa a ser armazenado pelo Gestor de Cobranças. Sendo assim, não precisa estar disponível no momento da geração de cada cobrança ou quando um pagador acessar o link para realizar o pagamento.


Modelo de Requisição:

Request

curl --location 'https://sandbox.openfinance.celcoin.dev//baas/v1/payment-links/customizations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer *****' \
--data '{
    "logo": "data:image/png;base64,iVBORw0KGgo….",
    "system": {
        "primary": "#fff",
        "secondary": "#000",
        "border": 6,
        "theme": "LIGHT"
    },
    "default": true
}'

Campos da requisição:

ObjetoCampoDescriçãoTipoLimiteObrigatório
accountNúmero da conta no BaaS. Quando não informado é aplicado para todas as contas que não possuem customização criada.string255Não
logoLogo no topo da página no link de pagamentostringmáximo 5MBSim
Logotipo da conta em base64 data URI. Formatos aceitos: png, jpeg, svg.
Sem limitação de pixel.
systemprimaryCor primária em hexadecimal.stringVálida de hexadecimal, iniciando em #Sim
systemsecondaryCor secundária em hexadecimal.stringVálida de hexadecimal, iniciando em #Sim
systemborderArredondamento dos componentes, quanto maior, botões e bordas mais arredondadas, quanto menor bordas mais retas.number0 à 60Sim
systemthemeLIGHT, DARK, AUTO.stringDeve ser alguma das palavras reservadas: LIGHT, DARK, AUTO. Sendo AUTO a configuração salva no sistema do clienteSim
defaultIndica se a customização deve ser usada automaticamente quando uma cobrança é criada sem o ID de customização.booleanSim

Response

{
    "version": "1.0.0",
    "body": {
        "id": "7ec2472f-3706-4ea7-90a6-b6ccdd006c01",
        "logoUrl": "https://blob.storage.com/uploads/c06e3980-8173-4b9d-96aa-452af45354d7-1779903038858-logo.png",
        "system": {
            "theme": "LIGHT",
            "primary": "#fff",
            "secondary": "#000",
            "border": 6
        },
        "isDefault": true,
        "createdAt": "2026-05-27T17:30:38.877Z",
        "updatedAt": "2026-05-27T17:30:38.877Z"
    },
    "status": 201
}

Campos da resposta

ObjetoCampoDescriçãotipo
idid da customização.string
accountNúmero da conta no BaaS.string
systemlogoUrlLogo no topo da página no link de pagamentostring
systemprimaryCor primária em hexadecimal.string
systemsecondaryCor secundária em hexadecimal.string
systemborderArredondamento dos componentes, quanto maior, botões e bordas mais arredondadas, quanto menor bordas mais retas.number
systemthemeLIGHT, DARK, AUTO.string
isDefaultIndica se a customização deve ser usada automaticamente quando uma cobrança é criada sem o ID de customização.boolean