Criar Link

Criar link de pagamento

POST /api/v1/link-payment

Requer autenticação Bearer. Veja Autenticação.

Request

Body

{
  "nomePagador": "Joao da Silva",
  "numeroInscricao": "12345678900",
  "isEstrangeiro": false,
  "valor": 150.75,
  "numeroParcelas": 3,
  "descricao": "Pagamento referente a mensalidade de julho",
  "userReference": "PEDIDO-2026-0001",
  "metodosPagamentosAceitos": [1, 2, 3],
  "diasExpiracao": 7
}

Campos

Campo	Tipo	Obrigatório	Descrição
`nomePagador`	string	sim	Nome completo do pagador
`numeroInscricao`	string	sim	CPF/CNPJ (ou documento estrangeiro se `isEstrangeiro`)
`valor`	number	sim	Valor total da cobrança
`isEstrangeiro`	boolean	não	Quando `true`, `numeroInscricao` não é validado como CPF/CNPJ
`numeroParcelas`	integer	não	Número de parcelas
`descricao`	string	não	Descrição/motivo do pagamento
`userReference`	string	não	Referência de controle do integrador
`metodosPagamentosAceitos`	array<integer>	não	Ids dos métodos aceitos (ex.: `1` cartão, `2` pix, `3` boleto)
`diasExpiracao`	integer	não	Dias até a expiração do link

Response

`200 OK`

{
  "linkPaymentId": 1001,
  "linkPaymentUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "nomePagador": "Joao da Silva",
  "numeroInscricao": "12345678900",
  "valor": 150.75,
  "numeroParcelas": 3,
  "status": { "code": 1, "description": "PENDING" },
  "urlPagamento": "https://pagamento.exemplo.com/link/a1b2c3d4",
  "tokenVerificacao": 482913,
  "userReference": "PEDIDO-2026-0001",
  "dataCriacao": "2026-08-01T14:30:00",
  "diasExpiracao": 7
}

Campos da resposta (principais)

Campo	Tipo	Descrição
`linkPaymentId`	integer	Identificador interno do link
`linkPaymentUuid`	string	UUID público do link (usado nas demais chamadas)
`valor`	number	Valor total
`status`	objeto	`{ code, description }` — status atual do link
`urlPagamento`	string	URL para o pagador realizar o pagamento
`tokenVerificacao`	integer	Token de verificação do link
`opcoesParcelamento`	array	Lista de `{ numberInstallments, amountInstallment }`
`metodosPagamentoAceitos`	array	Lista de `{ code, description }`
`dataCriacao`	string	Data/hora de criação

Erros

Status	Significado
`400`	Dados do link ausentes ou mal formatados
`401`	Não autorizado
`500`	Erro interno ao criar o link

Criar Link

On this page