Criar link de pagamento

🚧 Os endpoints de Link de Pagamento estão disponíveis apenas em ambiente de produção.

Cria um link de pagamento que permite ao cliente finalizar o pagamento por uma interface web customizável, suportando múltiplos métodos de pagamento.

POSThttps://{apiUrl}/set-payment-link

URL base da API

Token de autenticação

Body Params

titlestringrequired

Título exibido na página de pagamento

descriptionstringrequired

Descrição do produto ou serviço

activedbooleanoptional

Ativa o link imediatamente (default: false)

productsobjectoptional

Lista de produtos (externCode, name, price, min, max)

paymentConfigobjectoptional

Configuração de métodos (pix, credit, boleto, installments, boletoExpireDay, interest_rate_installment)

limitintegeroptional

Máximo de pagamentos — 0 = ilimitado

postbackUrlstringoptional

URL para receber notificações de pagamento

imageUrlstringoptional

URL da imagem exibida na página do link

expireAtdateoptional

Data de expiração YYYY-MM-DD

redirect_urlstringoptional

URL de redirecionamento após pagamento

phonebooleanoptional

Solicita telefone do cliente

address_deliverybooleanoptional

Solicita endereço de entrega

address_invoicebooleanoptional

Solicita endereço de cobrança

confirm_emailbooleanoptional

Solicita confirmação de e-mail

birthdatebooleanoptional

Solicita data de nascimento

sexbooleanoptional

Solicita gênero do cliente

curl --request POST \
  --url "https://{apiUrl}/set-payment-link" \
  --header "Content-Type: application/json" 
  --data '{}'

Response

Choose an example:

application/json

Exemplo de resposta

json

{
  "code": 200,
  "id": "e76873f4-dde7-40b0-9551-2712873f4c96",
  "link": "https://conta.dompagamentos.com.br/payment/link/e76873f4-dde7-40b0-9551-2712873f4c96"
}

Campos da resposta

codeinteger

Código HTTP da resposta (200 = sucesso)

idstring

UUID único do link de pagamento criado

linkstring

URL pública do link de pagamento para compartilhar com o cliente

Exemplo de requisição

curl --request POST \
  --url "https://{apiUrl}/set-payment-link" \
  --header "Authorization: Bearer {token}" \
  --header "Content-Type: application/json" \
  --data '{
    "title": "Meu Link de Pagamento",
    "description": "Link para compra do produto X",
    "products": [{ "name": "Produto X", "price": 99.90, "min": 1, "max": 10 }],
    "paymentConfig": { "pix": true, "credit": true, "boleto": false, "installments": 3 },
    "actived": true
  }'