API do Gateway

Links de pagamento

Checkout por URL: link simples na Transfeera ou página customizada hospedada na plataforma.

GET/payment-linksAutenticado

Listar links de pagamento

Lista os links da conta autenticada (simples e páginas customizadas). Cada usuário vê somente os que criou.

https://gateway.credito-direto.com/api/payment-links

cURL

curl --request GET \
  --url 'https://gateway.credito-direto.com/api/payment-links' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Exemplo de resposta

Response JSON

{
  "items": [
    {
      "id": "lnk_01",
      "type": "SIMPLE",
      "status": "pending",
      "payment_methods": ["pix", "boleto"],
      "amount": 8900,
      "name": "Taxa de adesão",
      "description": "Adesão plano anual",
      "slug": "a1b2c3d4e5f6",
      "link": "https://checkout.transfeera.com/abc",
      "page_url": null,
      "checkout_url": "https://checkout.transfeera.com/abc",
      "expires_at": "2026-09-30T23:59:59.000Z",
      "created_at": "2026-08-21T10:00:00.000Z",
      "images": []
    }
  ]
}

A listagem é isolada por usuário autenticado, não pela conta Transfeera do parceiro.
`type` é `SIMPLE` (URL da Transfeera) ou `CUSTOM` (página hospedada em `/p/:slug`).
`link` é a URL para compartilhar: checkout Transfeera no simples, página da plataforma no customizado.

POST/payment-linksAutenticado

Criar link de pagamento

Gera o checkout na Transfeera e persiste o link na conta do usuário. Use `CUSTOM` para uma página hospedada na plataforma.

https://gateway.credito-direto.com/api/payment-links

cURL

curl --request POST \
  --url 'https://gateway.credito-direto.com/api/payment-links' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN' \
  --header 'content-type: application/json' \
  --data '{ "type": "CUSTOM", "name": "Taxa de adesão", "amount": 8900, "payment_methods": ["pix", "boleto"], "description": "Adesão plano anual", "expires_at": "2026-09-30T23:59:59.000Z", "payment_method_details": { "boleto": { "days_until_due": 3 } } }'

Corpo da requisição

Campo	Tipo	Obrigatório	Descrição
type	"SIMPLE" \| "CUSTOM"	Não	Simples compartilha a URL da Transfeera. Customizado gera página em `/p/:slug`. Padrão: SIMPLE.
name	string	Sim	Nome interno / título do link.
amount	integer	Sim	Valor em centavos.
payment_methods	("pix" \| "boleto")[]	Sim	Meios aceitos no checkout do link.
expires_at	string (ISO 8601)	Sim	Expiração do link.
description	string	Não	Texto exibido ao pagador.
payment_method_details.boleto.days_until_due	integer	Não	Dias até o vencimento do boleto gerado a partir do link.

Exemplo de requisição

Body JSON

{
  "type": "CUSTOM",
  "name": "Taxa de adesão",
  "amount": 8900,
  "payment_methods": ["pix", "boleto"],
  "description": "Adesão plano anual",
  "expires_at": "2026-09-30T23:59:59.000Z",
  "payment_method_details": {
    "boleto": { "days_until_due": 3 }
  }
}

Depois de criar um link `CUSTOM`, envie as imagens em `POST /payment-links/:id/images`.
O botão Pagar da página pública abre `checkout_url` (Transfeera).

POST/payment-links/:id/imagesAutenticado

Enviar imagens da página

Anexa imagens à página customizada do usuário autenticado. Multipart (`images`), JPEG/PNG/WebP, até 5 arquivos de 2 MB.

https://gateway.credito-direto.com/api/payment-links/:id/images

cURL

curl --request POST \
  --url 'https://gateway.credito-direto.com/api/payment-links/:id/images' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador do link CUSTOM.

Campo de arquivo: `images` (um ou vários).
Responde 404 se o link não existir, não for do usuário ou não for `CUSTOM`.

DELETE/payment-links/:idAutenticado

Excluir link de pagamento

Remove o link do usuário, as imagens e o checkout correspondente. Pagamentos já liquidados não são revertidos.

https://gateway.credito-direto.com/api/payment-links/:id

cURL

curl --request DELETE \
  --url 'https://gateway.credito-direto.com/api/payment-links/:id' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer TOKEN'

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador do link.

Exemplo de resposta

Response JSON

{ "ok": true }

GET/public/payment-pages/:slug

Obter página pública

Retorna o conteúdo da página customizada para o pagador. Sem autenticação. Não inclui userId nem partnerId.

https://gateway.credito-direto.com/api/public/payment-pages/:slug

cURL

curl --request GET \
  --url 'https://gateway.credito-direto.com/api/public/payment-pages/:slug' \
  --header 'accept: application/json'

Parâmetros de caminho

Campo	Tipo	Obrigatório	Descrição
slug	string	Sim	Identificador opaco da página.

Exemplo de resposta

Response JSON

{
  "slug": "a1b2c3d4e5f6",
  "type": "CUSTOM",
  "name": "Taxa de adesão",
  "description": "Adesão plano anual",
  "amount": 8900,
  "payment_methods": ["pix", "boleto"],
  "status": "pending",
  "expires_at": "2026-09-30T23:59:59.000Z",
  "checkout_url": "https://checkout.transfeera.com/abc",
  "images": [
    { "id": "img_01", "url": "/api/public/payment-pages/a1b2c3d4e5f6/images/img_01" }
  ]
}

A página do pagador na aplicação é `/p/:slug`.
Imagens são servidas em `GET /public/payment-pages/:slug/images/:imageId`.
Links `SIMPLE` não têm página pública.