---
updatedAt: 2026-04-06T17:34:05.000Z
agentTools:
  projectIndex: https://docs.pagar.me/v4/llms.txt
---

# Objeto de Link de Pagamento (PaymentLink)

Ao criar, cancelar ou buscar por um Link de Pagamento, este é o objeto que você recebe como resposta.

<Table align={["left","left"]}>
  <thead>
    <tr>
      <th style={{ textAlign: "left" }}>
        Propriedade
      </th>

      <th style={{ textAlign: "left" }}>
        Descrição
      </th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td style={{ textAlign: "left" }}>
        **object**
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        Nome do tipo de objeto.  

        * \*Valor retornado\*\*: `payment_link`
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **name**\
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        Nome do Link de Pagamento
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **amount**\
        `Integer`
      </td>

      <td style={{ textAlign: "left" }}>
        Valor, em centavos, do Link de Pagamento
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **date\_created**\
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        Data de criação do Link de Pagamento no formato `ISODate`
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **date\_updated**\
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        Data da última atualização do Link de Pagamento no formato `ISODate`
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **expires\_at**\
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        Data de expiração do Link de Pagamento no formato `ISODate`
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **id**\
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        Identificador do Link de Pagamento. Ex: pl\_cjkcnpnug01w3nx6d7rz1dgit
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **items**\
        `Object`
      </td>

      <td style={{ textAlign: "left" }}>
        Dados sobre os produtos comprados. O objeto `items` é descrito [aqui](https://docs.pagar.me/v3/reference#objeto-items-itens)
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **max\_orders**\
        `Integer`
      </td>

      <td style={{ textAlign: "left" }}>
        Número máximo de pedidos gerados
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **payment\_config**\
        `Object`
      </td>

      <td style={{ textAlign: "left" }}>
        Dados sobre as configurações de pagamento. O objeto `payment_config` é descrito [aqui](https://docs.pagar.me/v3/reference#objeto-de-configuração-de-pagamento)
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **short\_id**\
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        Identificador utilizado para acessar o Link de Pagamento via URL
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **status**\
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        Representa o estado do Link de Pagamento. Valores possíveis: `active`, `canceled`, `expired`.
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **url**\
        `String`
      </td>

      <td style={{ textAlign: "left" }}>
        URL para acessar o Link de Pagamento
      </td>
    </tr>

    <tr>
      <td style={{ textAlign: "left" }}>
        **postback\_config**\
        `Object`
      </td>

      <td style={{ textAlign: "left" }}>
        Dados sobre as configurações do postback do link de pagamento
      </td>
    </tr>
  </tbody>
</Table>

<br />

> ❗️ Atenção: Essa versão de API será descontinuada
>
> Essa versão da API Pagar.me já não é mais atualizada e, em breve, deixará de funcionar. Para que sua loja possa vender sem problemas, você precisa realizar sua integração usando a versão mais recente da nossa API, a V5.
>
> No canto superior esquerdo da tela é indicado qual versão da documentação você está vendo. Clique na seta onde indica a versão e altere para a V5 para acessar a documentação.
>
> Se você já é cliente, precisa realizar obrigatoriamente a migração para a versão V5.
>
> Em caso de dúvidas, basta entrar em contato com o nosso time de atendimento através do e-mail, enviando a sua dúvida para <relacionamento@pagar.me> e por telefone, ligando para 4004-1330. Se você já é cliente pode também entrar em contato através do chat dentro da sua Dashboard.