Link de Pagamento
Criar Link
Cria um link de pagamento para um pagador
POST /api/v1/link-payment
{
"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],
"diasExpiracao": 7
}
| 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: 1 cartão, 2 pix |
diasExpiracao | integer | não | Dias até a expiração do link |
{
"linkPaymentId": 1001,
"linkPaymentUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"clienteId": 3001,
"nomePagador": "Joao da Silva",
"numeroInscricao": "12345678900",
"isEstrangeiro": false,
"valor": 150.75,
"numeroParcelas": 3,
"status": { "code": 1, "description": "CREATED" },
"urlPagamento": "https://pagamento.exemplo.com/link/a1b2c3d4",
"descricao": "Pagamento referente a mensalidade de julho",
"tokenVerificacao": 482913,
"opcoesParcelamento": [
{ "numberInstallments": 1, "amountInstallment": 150.75 },
{ "numberInstallments": 2, "amountInstallment": 75.38 },
{ "numberInstallments": 3, "amountInstallment": 50.25 }
],
"userReference": "PEDIDO-2026-0001",
"comprovantePagamento": null,
"identificadorTransacao": null,
"metodoPagamento": null,
"dataCriacao": "2026-08-01T14:30:00",
"metodosPagamentoAceitos": [
{ "code": 1, "description": "Cartão de Crédito" },
{ "code": 2, "description": "Pix" }
],
"diasExpiracao": 7
}
| Campo | Tipo | Descrição |
|---|
linkPaymentId | integer | Identificador interno do link |
linkPaymentUuid | string | UUID público do link (usado nas demais chamadas) |
clienteId | integer | Identificador do cliente vinculado ao link |
nomePagador | string | Nome do pagador |
numeroInscricao | string | CPF, CNPJ ou documento estrangeiro do pagador |
isEstrangeiro | boolean | Indica se o pagador é estrangeiro |
valor | number | Valor total da cobrança |
numeroParcelas | integer | Número de parcelas do pagamento |
status | object | Status atual do link — { code, description } |
urlPagamento | string | URL para o pagador realizar o pagamento |
descricao | string | Descrição ou motivo do pagamento |
tokenVerificacao | integer | Token de verificação do link |
opcoesParcelamento | array | Opções de parcelamento — ver abaixo |
userReference | string | Referência de controle do integrador |
comprovantePagamento | string | Comprovante do pagamento. Preenchido após o pagamento |
identificadorTransacao | string | Identificador da transação de pagamento. Preenchido após o pagamento |
metodoPagamento | object | Método efetivamente usado — { code, description }. Preenchido após o pagamento |
dataCriacao | string | Data/hora de criação do link |
metodosPagamentoAceitos | array | Métodos aceitos — { code, description }: 1 Cartão de Crédito, 2 Pix |
diasExpiracao | integer | Dias até a expiração do link |
| Campo | Tipo | Descrição |
|---|
numberInstallments | integer | Quantidade de parcelas |
amountInstallment | number | Valor de cada parcela |
| Status | Significado |
|---|
400 | Dados do link ausentes ou mal formatados |
401 | Não autorizado |
500 | Erro interno ao criar o link |