GnApiSdkElixir.Carnet (Gerencianet v0.1.9) View Source

Um carnê é um conjunto de transações (parcelas) geradas em lote e com forma de pagamento já definida. As parcelas de um carnê vencem mensalmente, de acordo com a data definida pelo integrador.

Link to this section Summary

Functions

Possibilita alterar a data de vencimento de uma determinada parcela de um carnê. Para tal, é necessário que você informe o carnet_id, a parcela que deseja e a expire_at (nova data de vencimento, no formato YYYY-MM-DD).

Utilizado para geração de um conjunto de transações (parcelas) geradas em lote e com uma forma de pagamento já definida. As parcelas de um carnê vencem mensalmente, de acordo com a data definida pelo integrador.

Retorna informações sobre um carnê criado. Cada transação criada via carnê possui uma única chave identificadora que a identifica.

O histórico de um carnê é semelhante ao histórico de uma transação. Porém, ele reflete as ações que o carnê em si sofreu. E, da mesma forma, é possível adicionar mensagens personalizadas ao histórico de um carnê, sem que estas, contudo, influenciem no fluxo do mesmo.

Permite incluir em um carnê informações como notification_url e custom_id. Para isso, você precisa informar o carnet_id do carnê existente no qual deseja incluir essas informações. Este endpoint é de extrema importância para atualizar sua URL de notificação atrelada ao carnê ou modificar o custom_id previamente associado aos carnês.

Possibilita alterar a data de vencimento de uma determinada parcela de um carnê. Para tal, é necessário que você informe o carnet_id, a parcela que deseja e a expire_at (nova data de vencimento, no formato YYYY-MM-DD).

Possibilita efetuar o cancelamento de uma parcela específica de um carnê existente. Para isso, você deve informar o carnet_id e o número da parcela que deseja efetuar o cancelamento.

Este método possibilita que uma determinada parcela de um carnê seja reenviado para um endereço de e-mail. Para tal, você deve informar o carnet_id desejado.

Este método possibilita que o carnê seja reenviado para um endereço de email. É preciso que você informe o carnet_id do carnê desejado.

Permite marcar como pago (baixa manual) uma determinada parcela de um carnê. Para tal, você deverá informar o carnet_id e o número da parcela do carnê que deseja marcar como pago.

Link to this section Functions

Possibilita alterar a data de vencimento de uma determinada parcela de um carnê. Para tal, é necessário que você informe o carnet_id, a parcela que deseja e a expire_at (nova data de vencimento, no formato YYYY-MM-DD).

Utilizado para geração de um conjunto de transações (parcelas) geradas em lote e com uma forma de pagamento já definida. As parcelas de um carnê vencem mensalmente, de acordo com a data definida pelo integrador.

Retorna informações sobre um carnê criado. Cada transação criada via carnê possui uma única chave identificadora que a identifica.

Link to this function

history(carnet_id, description)

View Source

O histórico de um carnê é semelhante ao histórico de uma transação. Porém, ele reflete as ações que o carnê em si sofreu. E, da mesma forma, é possível adicionar mensagens personalizadas ao histórico de um carnê, sem que estas, contudo, influenciem no fluxo do mesmo.

Link to this function

metadata(carnet_id, metadata)

View Source

Permite incluir em um carnê informações como notification_url e custom_id. Para isso, você precisa informar o carnet_id do carnê existente no qual deseja incluir essas informações. Este endpoint é de extrema importância para atualizar sua URL de notificação atrelada ao carnê ou modificar o custom_id previamente associado aos carnês.

Link to this function

parcel(carnet_id, parcel, expire_at)

View Source

Possibilita alterar a data de vencimento de uma determinada parcela de um carnê. Para tal, é necessário que você informe o carnet_id, a parcela que deseja e a expire_at (nova data de vencimento, no formato YYYY-MM-DD).

Link to this function

parcel_cancel(carnet_id, parcel)

View Source

Possibilita efetuar o cancelamento de uma parcela específica de um carnê existente. Para isso, você deve informar o carnet_id e o número da parcela que deseja efetuar o cancelamento.

Link to this function

parcel_resend(carnet_id, parcel, email)

View Source

Este método possibilita que uma determinada parcela de um carnê seja reenviado para um endereço de e-mail. Para tal, você deve informar o carnet_id desejado.

Link to this function

resend(carnet_id, email)

View Source

Este método possibilita que o carnê seja reenviado para um endereço de email. É preciso que você informe o carnet_id do carnê desejado.

Link to this function

settle(carnet_id, parcel)

View Source

Permite marcar como pago (baixa manual) uma determinada parcela de um carnê. Para tal, você deverá informar o carnet_id e o número da parcela do carnê que deseja marcar como pago.