GnApiSdkElixir.Charge (Gerencianet v0.1.7) View Source

Módulo de integração de cobranças

Link to this section Summary

Functions

Você pode definir que a transação será do tipo boleto balancete. Este é um modelo muito utilizado por condomínios e contabilidades.

Permite efetuar a alteração da data de vencimento de uma transação em que a forma de pagamento é boleto bancário (banking_billet) e que ainda não foi paga. O formato da data de vencimento deve seguir o seguinte padrão: YYYY-MM-DD.

Permite o reenvio do boleto bancário para o e-mail desejado.

Através deste endpoint é possível cancelar uma transação criada. Somente transações com status new, waiting, unpaid ou link podem ser canceladas.

Permite criar uma nova transação; retorna um código identificador da transação denominado charge_id.

Permite criar uma transação já associando um método de pagamento, podendo ser boleto bancário ou cartão de crédito, em apenas uma etapa.

Permite criar uma nova transação; retorna um código identificador da transação denominado charge_id.

O histórico de uma transação representa todas as ações que ocorreram com esta transação até o presente momento. É possível adicionar mensagens personalizadas a este histórico utilizando o endpoint /v1/charge/:id/history.

Permite retornar um link para uma tela de pagamento da Gerencianet. Em outras palavras, o integrador gera uma cobrança e, em seguida, ao invés de definir o pagamento via boleto bancário ou cartão de crédito, o integrador pode solicitar um link escolhendo inclusive se a tela de pagamento deve aceitar boleto, cartão ou ambos..

Permite retornar um link para uma tela de pagamento da Gerencianet. Em outras palavras, o integrador gera uma cobrança e, em seguida, ao invés de definir o pagamento via boleto bancário ou cartão de crédito, o integrador pode solicitar um link escolhendo inclusive se a tela de pagamento deve aceitar boleto, cartão ou ambos..

Permite incluir informações como notification_url e custom_id à uma transação existente. Este endpoint é de extrema importância para atualizar sua URL de notificação atrelada às transações ou modificar o custom_id previamente associado às suas transações.

Permite associar um método de pagamento à uma transação já criada. Após gerar uma transação através do endpoint POST /v1/charge, esta fica classificada com o status de new (novo), ou seja, uma nova transação foi gerada, porém, nenhum método de pagamento foi atribuído a ela.

Você pode definir que a transação será do tipo boleto balancete. Este é um modelo muito utilizado por condomínios e contabilidades.

Link to this section Types

Specs

metadata() :: %{custom_id: String.t(), notification_url: String.t()}

Link to this section Functions

Link to this function

balance_sheet(charge_id, data)

View Source

Você pode definir que a transação será do tipo boleto balancete. Este é um modelo muito utilizado por condomínios e contabilidades.

Link to this function

billet(charge_id, expire)

View Source

Permite efetuar a alteração da data de vencimento de uma transação em que a forma de pagamento é boleto bancário (banking_billet) e que ainda não foi paga. O formato da data de vencimento deve seguir o seguinte padrão: YYYY-MM-DD.

Link to this function

billet_resend(charge_id, email)

View Source

Permite o reenvio do boleto bancário para o e-mail desejado.

Através deste endpoint é possível cancelar uma transação criada. Somente transações com status new, waiting, unpaid ou link podem ser canceladas.

Permite criar uma nova transação; retorna um código identificador da transação denominado charge_id.

Link to this function

create_one_step(items, payment)

View Source

Permite criar uma transação já associando um método de pagamento, podendo ser boleto bancário ou cartão de crédito, em apenas uma etapa.

Permite criar uma nova transação; retorna um código identificador da transação denominado charge_id.

Link to this function

history(charge_id, description)

View Source

O histórico de uma transação representa todas as ações que ocorreram com esta transação até o presente momento. É possível adicionar mensagens personalizadas a este histórico utilizando o endpoint /v1/charge/:id/history.

Permite retornar um link para uma tela de pagamento da Gerencianet. Em outras palavras, o integrador gera uma cobrança e, em seguida, ao invés de definir o pagamento via boleto bancário ou cartão de crédito, o integrador pode solicitar um link escolhendo inclusive se a tela de pagamento deve aceitar boleto, cartão ou ambos..

Link to this function

metadata(charge_id, metadata)

View Source

Permite incluir informações como notification_url e custom_id à uma transação existente. Este endpoint é de extrema importância para atualizar sua URL de notificação atrelada às transações ou modificar o custom_id previamente associado às suas transações.

Permite associar um método de pagamento à uma transação já criada. Após gerar uma transação através do endpoint POST /v1/charge, esta fica classificada com o status de new (novo), ou seja, uma nova transação foi gerada, porém, nenhum método de pagamento foi atribuído a ela.

Você pode definir que a transação será do tipo boleto balancete. Este é um modelo muito utilizado por condomínios e contabilidades.