Classe TGNCharge

DescriçãoHierarquiaCamposMétodosProperties

Unit

Declaração

type TGNCharge = class(TObject)

Descrição

Classe para criação de transações.

Usado para criação de transações manuais, transações são criadas sem informações de pagamento.

Hierarquia

  • TObject
  • TGNCharge

Visão Geral

Métodos

Public constructor Create;
Public destructor Destroy; override;
Public function ToJsonString: string;
Public class function FromJsonString(AJsonString: string): TGNCharge;
Public procedure AddItem(AItem: TGNChargeItem);
Public function CreateCharge(): TGNChargeResponse;
Public class function CancelCharge(AChargeID: extended): TGNCodeResponse;
Public class function GetCharge(AChargeID: extended): TGNChargeDetail; static;
Public class function PayBillet(AChargeID: extended; APayment: TGNPaymentBillet): TGNPaymentBilletResponse;
Public class function UpdateMetadata(AChargeID: extended; AMetadata: TGNMetadata): TGNCodeResponse;
Public class function BilletUpdate(AChargeID: extended; AExpireAt: string): TGNCodeResponse;
Public class function ResendCharge(AChargeID: extended; AEmail: string): TGNCodeResponse;
Public class function HistoryCharge(AChargeID: extended; ADescription: string): TGNCodeResponse;

Properties

Public property Items: TArray<TGNChargeItem> read FItems write FItems;
Public property Metadata: TGNMetadata read FMetadata write FMetadata;

Descrição

Métodos

Public constructor Create;
 
Public destructor Destroy; override;
 
Public function ToJsonString: string;

Deserializa o objeto para uma string JSON.

Retornos

String JSON do objeto.

Public class function FromJsonString(AJsonString: string): TGNCharge;

Serializa o objeto a partir de uma string JSON.

Parâmetros
AJsonStringString
JSON.
Retornos

Objeto GNCharge.TGNCharge.

Public procedure AddItem(AItem: TGNChargeItem);

Adiciona um Item a lista de Itens da transação.

Parâmetros
AItemItem
da transação, do tipo GNCharge.TGNChargeItem.
Public function CreateCharge(): TGNChargeResponse;

Cria uma transação.

Retornos

Objeto GNChargeResponse.TGNChargeResponse.

Public class function CancelCharge(AChargeID: extended): TGNCodeResponse;

Cancela uma transação.

Parâmetros
AChargeIDID
da transação.
Retornos

Objeto GNRequest.TGNCodeResponse.

Public class function GetCharge(AChargeID: extended): TGNChargeDetail; static;

Consulta uma transação.

Parâmetros
AChargeIDID
da transação.
Retornos

Objeto GNCharge.TGNChargeDetail.

Public class function PayBillet(AChargeID: extended; APayment: TGNPaymentBillet): TGNPaymentBilletResponse;

Adiciona pagamento Boleto a uma transação.

Parâmetros
AChargeIDID
da transação.
APaymentObjeto
de Boleto do tipo GNPaymentBillet.TGNPaymentBillet.
Retornos

Objeto GNPaymentBillet.TGNPaymentBilletResponse.

Public class function UpdateMetadata(AChargeID: extended; AMetadata: TGNMetadata): TGNCodeResponse;

Atualiza Metadata de uma transação.

Parâmetros
AChargeIDID
da transação.
APaymentObjeto
Metadata do tipo GNCharge.TGNMetadata.
Retornos

Objeto GNRequest.TGNCodeResponse.

Public class function BilletUpdate(AChargeID: extended; AExpireAt: string): TGNCodeResponse;

Atualiza Boleto de uma transação.

Parâmetros
AChargeIDID
da transação.
AExpireAtData
de expiração no formato YYYY-MM-DD.
Retornos

Objeto GNRequest.TGNCodeResponse.

Public class function ResendCharge(AChargeID: extended; AEmail: string): TGNCodeResponse;

Reenvia uma transação.

Parâmetros
AChargeIDID
da transação.
AEmailE-mail
de reenvio.
Retornos

Objeto GNRequest.TGNCodeResponse.

Public class function HistoryCharge(AChargeID: extended; ADescription: string): TGNCodeResponse;

Adiciona um histórico a uma transação.

Parâmetros
AChargeIDID
da transação.
ADescriptionDescrição
do histórico.
Retornos

Objeto GNRequest.TGNCodeResponse.

Properties

Public property Items: TArray<TGNChargeItem> read FItems write FItems;

Items da transação.

Lista de Itens do tipo GNCharge.TGNChargeItem.

Public property Metadata: TGNMetadata read FMetadata write FMetadata;

Metadata da transação.

JBS Soluções 2015