Criar link de pagamento

POST/api/v1/payment-links/

{
  "value": 990,
  "description": "Produto XYZ",
  "payer_name": "Joao da Silva",
  "document": "52998224725",
  "email": "[email protected]",
  "mobile": "11999999999",
  "number_of_installments": 1,
  "link_exp_period": 1,
  "webhookUrl": "https://meu-sistema.com/webhook/link"
}

Campo	Tipo	Obrigatório	Descrição
value	integer	Sim	Valor em centavos, inteiro. Número com fração devolve 400 A valid integer is required
merchant	integer	Não	ID do lojista. Preenchido pelo token — não envie
description	string	Não	Descrição. Máx. 100 caracteres
payer_name	string	Não	Nome do pagador, pré-preenchido no checkout. Máx. 20 caracteres. merchant_name é aceito como alias; se vierem os dois, vale payer_name
document	string	Não	CPF ou CNPJ do pagador. Máx. 20 caracteres
email	string	Não	E-mail do pagador. Máx. 100 caracteres
mobile	string	Não	Telefone do pagador. Máx. 20 caracteres
number_of_installments	integer	Não	Parcelas de 1 a 12. Padrão 1
link_exp_period	integer	Não	Expiração: 1 = 24h, 2 = 48h, 3 = 72h. Padrão 2
webhookUrl	string	Não	URL do webhook da seção Webhook de link de pagamento. Precisa ser HTTPS público (veja as regras do endpoint). Também aceito como webhook_url, callbackUrl ou callback_url

aviso

URL fora da regra (http://, localhost, endereço interno, host que não resolve) devolve 400 no formato de erro por campo, e o link não é criado:

{ "webhookUrl": ["Enter a safe public HTTPS URL."] }

Resposta 201

{
  "id": 18,
  "status": 1,
  "status_label": "Pendente",
  "merchant_id": 2,
  "merchant_company_name": "Loja Homolog Pag",
  "value": 990,
  "description": "Produto XYZ",
  "payer_name": "Joao da Silva",
  "merchant_name": "Joao da Silva",
  "document": "52998224725",
  "email": "[email protected]",
  "mobile": "11999999999",
  "link_exp_period": 1,
  "number_of_installments": 1,
  "payment_link_guid": "0a798f92-72ef-4809-9a6a-b318f067c2ee",
  "payment_link_url": "https://plataforma.yumepayhml.com.br/checkout/0a798f92-72ef-4809-9a6a-b318f067c2ee/step-1/",
  "payment_date": null,
  "webhookUrl": "https://meu-sistema.com/webhook/link",
  "created_at": "2026-10-06T09:49:13.415062-03:00"
}

merchant_name na resposta repete payer_name — é o nome do pagador, mantido por compatibilidade. O nome do lojista está em merchant_company_name.

É o payment_link_url que você envia ao pagador. Guarde o id para acompanhar o pagamento, e o payment_link_guid para as rotas de checkout da seção Montar o seu próprio checkout.