#Introdução

Hooks de cartão podem ser configurados de acordo com os tipos de eventos desejados. Novos eventos podem ser adicionados conforme a necessidade.

Em casos de falha por problemas de comunicação, autenticação ou indisponibilidade, as notificações serão reenviadas a cada 5 minutos por um período de 2 horas. Após este período o reenvio será a cada 5 horas por um período de 3 dias.

Se após estas tentativas a notificação não tiver sucesso na entrega, será necessário a consulta do status da transação no endpoint:

https://api.gsurfnet.com/gs-payment-ecommerce/v1/payments/card/{gti}

#Tipos de eventos

CREATION: Evento emitido quando uma transação de cartão for criada no gateway (Salvo na base gsurf).

AUTHORIZATION: Evento emitido quando uma transação de cartão é autorizada no provedor (Gerado no banco emissor).

AUTHORIZATION_ERROR: Evento emitido quando houver erro na autorização da transação de cartão no provedor.

CONFIRMATION: Evento emitido quando uma transação de cartão é confirmada no provedor.

CONFIRMATION_ERROR: Evento emitido quando houver erro na confirmação da transação de cartão no provedor.

UNDOING: Evento disparado quando a transação é desfeita no provedor. O pagamento não foi realizado.

UNDOING_ERROR: Evento disparado quando houve erro no processo de desfazimento da transação no provedor e esgotou-se as tentativas.

ANTIFRAUD_EXECUTION: Evento emitido quando o anti fraud é executado.

ANTIFRAUD_EXECUTION_ERROR: Evento emitido quando houver erro na execução do anti fraud.

EXPIRATION: Evento emitido quando uma transação de cartão for expirada, impossibilitando seu pagamento.

AUTHENTICATION: Evento emitido quando uma transação de cartão é autenticada no provedor.

AUTHENTICATION_ERROR: Evento emitido quando houver erro na autenticação da transação de cartão no provedor.

Obs: O payload do hook é versionado. As versões indicam os campos que são contidos no payload.

#Payload

#Changelog

Versão	Alterações
V1.4	Em `anti_fraud_analysis_data`, foi adicionado o bloco `provider_data` para comportar dados específicos do provedor de antifraude. Foram adicionados os campos `provider_name` e `provider_id`, além de dois novos objetos dinâmicos: `authorization_response` (dados específicos da resposta de autorização do provedor) e `review_response` (dados específicos da revisão do antifraude).
V1.3	Adicionado o campo `current_amount` (Valor atual da venda) dentro do objeto `sale_data`. Foi adicionado o bloco `authorizer_data` em `transaction_data`, contendo os campos `response_message` e `response_code` para mapear respostas diretas da bandeira.
V1.2	Mudança no formato das datas de `payment_data` (`creation_time`, `update_time`, `effective_time`, `confirm_time`), que passaram a incluir o offset de fuso horário (ex: `...T12:03:34-03:00`).
V1.1	Adicionado o campo `subacquirer_document` em `payment_data`. O campo `submerchant_id` foi movido de `payment_data` para `sale_data`. Adicionados os campos `description` e `gsurf_code` dentro de `card_brand`.
V1.0	Estrutura inicial do payload de hooks.

#V1.0

versionstringconst: "1.0"

event_typestring

Enum: "CREATION", "AUTHORIZATION_REQUEST", "AUTHORIZATION", "AUTHORIZATION_ERROR", "CAPTURE", "CONFIRMATION", "CONFIRMATION_ERROR", "ANTIFRAUD_EXECUTION", "ANTIFRAUD_EXECUTION_ERROR", "UNDOING", "UNDOING_ERROR", "EXPIRATION"

entitystringconst: "CardPayment"

payloadobject

sale_dataobject

Dados referentes a venda.

amountinteger

Valor da venda.

merchant_correlation_idstring

Identificador da venda na loja.

order_idstring

Número do pedido.

installmentsinteger

Número da parcela.

payment_dataobject

Dados do pagamento.

gtistring

Identificador único da transação de cartão.

statusstring

Enum: "NEW", "EXPIRED", "AUTHORIZATION_IN_PROGRESS", "AUTHORIZED", "AUTHORIZATION_ERROR", "CONFIRMATION_IN_PROGRESS", "CONFIRMED", "CONFIRMATION_ERROR", "UNDOING_IN_PROGRESS", "UNDONE", "UNDOING_ERROR", "DENIED"

amount_paidinteger

Valor pago.

channelstring

Canal

creation_timestring

Data de criação do pagamento.

update_timestring

Data da última atualização do pagamento.

effective_timestring | null

Data do pagamento no provedor.

confirm_timestring | null

Data da confirmação do pagamento no gateway.

submerchant_idstring

Identificador da loja.

creation_originstring

Origem da criação da transação.

Enum: "NORMAL", "RECURRENCE"

transaction_dataobject

Dados da transação.

gsurf_usnstring

Número sequencial gsurf.

card_dataobject

Dados do cartão.

masked_cardstring | null

Número do cartão mascarado.

card_brandobject

Dados da bandeira do cartão.

descriptionstring | null

Nome da bandeira do cartão.

gsurf_codeinteger

Código da bandeira na gsurf.

entry_modestring | null

Modo de entrada de pagamento no gateway, virtual/físico.

transaction_typestring

tipo de transação

Enum: "DEBIT", "CREDIT"

installment_typestring

tipo de parcelamento

Enum: "BY_ISSUER", "BY_MERCHANT"

anti_fraud_analysis_dataobject

Dados de resposta referente à análise do anti-fraude.

statusstring

Enum: "IGNORED", "PENDING", "ACCEPTED", "REJECTED", "IN_REVIEW", "ERROR"

codeinteger

Enum: 100, 480, 481

messagestring | null

Menssagem com informações adicionais sobre o status do antifraude

provider_dataobject

Dados do provedor/adquirente.

response_messagestring | null

Mensagem de resposta da provedor/adquirente.

response_codestring | null

Código da resposta da provedor/adquirente.

authorization_codestring | null

Código de autorização da transação.

acquirer_namestring | null

Nome do adquirente.

provider_namestring | null

Nome do provedor.

provider_idstring | null

Id do resgistro da provedor/adquirente na GSurf.

gsurf_correlation_idstring | null

Identificação da transação de cartão no provedor/adquirente.

acquirer_authorization_usnstring | null

Número sequencial único da autorização da transação no adquirente.

acquirer_confirmation_usnstring | null

Número sequencial único da confirmação da transação no adquirente.

provider_usnstring | null

Número sequencial único da autorização da transação no provedor. Será o mesmo que o acquirer_authorization_usn para casos de comunicação direta com o adquirente.

tidstring | null

Id da transação na adquirente.

error_infoobject

Atributo recebido somente em eventos Emitidos para erro. Contém os dados com os valores de erro

codestring

Código do erro.

messagestring

Mensagem descritiva do erro.

recurrence_dataobject

Atributo recebido somente em eventos Emitidos para transações de recorrencia. Contém os dados da recorrencia.

idstring

Id da recorrencia.

#Exemplo

{
  "version": "1.0",
  "event_type": "AUTHORIZATION_ERROR",
  "entity": "CardPayment",
  "payload": {
    "sale_data": {
      "amount": 1000,
      "merchant_correlation_id": "026b0627-83dc-42a0-bacc-a06f0da1227",
      "order_id": "20220303timi",
      "installments": 1,
    },
    "payment_data": {
      "gti": "ba7e5785-bf2d-4cb3-93d4-2aed693599e9",
      "status": "AUTHORIZATION_ERROR",
      "amount_paid": 0,
      "channel": "ECOMMERCE",
      "creation_time": "2022-02-03T12:03:34",
      "update_time": "2022-02-03T12:03:37",
      "effective_time": null,
      "confirm_time": null,
      "submerchant_id": "53391845015",
      "creation_origin": "NORMAL"
    },
    "transaction_data": {
      "gsurf_usn": "220324000036",
      "card_data": {
        "masked_card": "544828******0007",
        "card_brand": {
          "description": "Mastercard",
          "gsurf_code": 55
        }
      },
      "entry_mode": "virtual",
      "transaction_type": "CREDIT",
      "installment_type": "BY_MERCHANT",
      "provider_data": {
        "response_message": "Success.",
        "response_code": "00",
        "authorization_code": "326260",
        "acquirer_name": "rede",
        "provider_name": "e-sitef",
        "provider_id": "16380c7b-f478-407f-9c2b-a4e0531cef9e",
        "gsurf_correlation_id": "10012203241526016159",
        "acquirer_authorization_usn": "961714228",
        "acquirer_confirmation_usn": null,
        "provider_usn": null,
        "tid": "10012405311627496699"
      },
      "anti_fraud_analysis_data": {
        "status": "IGNORED",
        "code": null,
        "message": null
      }
    },
    "error_info": {
      "code": "INTEGRATION_ERROR",
      "message": "Response From e-sitef does not represent success! - status_code = 403"
    }
  }
}

#V1.1

versionstringconst: "1.1"

event_typestring

entitystringconst: "CardPayment"

payloadobject

sale_dataobject

Dados referentes a venda.

amountinteger

Valor da venda.

merchant_correlation_idstring

Identificador da venda na loja.

order_idstring

Número do pedido.

installmentsinteger

Número da parcela.

submerchant_idstring

Identificador da loja.

payment_dataobject

Dados do pagamento.

gtistring

Identificador único da transação de cartão.

statusstring

amount_paidinteger

Valor pago.

channelstring

Canal

creation_timestring

Data de criação do pagamento.

update_timestring

Data da última atualização do pagamento.

effective_timestring | null

Data do pagamento no provedor.

confirm_timestring | null

Data da confirmação do pagamento no gateway.

subacquirer_documentstring

Documento do subadquirente

creation_originstring

Origem da criação da transação.

Enum: "NORMAL", "RECURRENCE"

transaction_dataobject

Dados da transação.

gsurf_usnstring

Número sequencial gsurf.

card_dataobject

Dados do cartão.

masked_cardstring | null

Número do cartão mascarado.

card_brandobject

Dados da bandeira do cartão.

descriptionstring | null

Nome da bandeira do cartão.

gsurf_codeinteger

Código da bandeira na gsurf.

entry_modestring | null

Modo de entrada de pagamento no gateway, virtual/físico.

transaction_typestring

tipo de transação

Enum: "DEBIT", "CREDIT"

installment_typestring

tipo de parcelamento

Enum: "BY_ISSUER", "BY_MERCHANT"

anti_fraud_analysis_dataobject

Dados de resposta referente à análise do anti-fraude.

statusstring

Enum: "IGNORED", "PENDING", "ACCEPT", "REJECT", "IN_REVIEW", "ERROR"

codeinteger

Enum: 100, 480, 481

messagestring | null

Menssagem com informações adicionais sobre o status do antifraude

provider_dataobject

Dados do provedor/adquirente.

response_messagestring | null

Mensagem de resposta da provedor/adquirente.

response_codestring | null

Código da resposta da provedor/adquirente.

authorization_codestring | null

Código de autorização da transação.

acquirer_namestring | null

Nome do adquirente.

provider_namestring | null

Nome do provedor.

provider_idstring | null

Id do resgistro da provedor/adquirente na GSurf.

gsurf_correlation_idstring | null

Identificação da transação de cartão no provedor/adquirente.

acquirer_authorization_usnstring | null

Número sequencial único da autorização da transação no adquirente.

acquirer_confirmation_usnstring | null

Número sequencial único da confirmação da transação no adquirente.

provider_usnstring | null

Número sequencial único da autorização da transação no provedor. Será o mesmo que o acqurier_authorization_usn para casos de comunicação direta com o adquirente.

tidstring | null

Id da transação na adquirente.

error_infoobject

Atributo recebido somente em eventos Emitidos para erro. Contém os dados com os valores de erro

codestring

Código do erro.

messagestring

Mensagem descritiva do erro.

recurrence_dataobject

Atributo recebido somente em eventos Emitidos para transações de recorrencia. Contém os dados da recorrencia.

idstring

Id da recorrencia.

#Exemplo

{
  "version": "1.1",
  "event_type": "AUTHORIZATION",
  "entity": "CardPayment",
  "payload": {
    "sale_data": {
      "amount": 1000,
      "merchant_correlation_id": "026b0627-83dc-42a0-bacc-a06f0da1227",
      "order_id": "20220303timi",
      "installments": 1,
      "submerchant_id": "53391845015"
    },
    "payment_data": {
      "gti": "ba7e5785-bf2d-4cb3-93d4-2aed693599e9",
      "status": "AUTHORIZED",
      "amount_paid": 0,
      "channel": "ECOMMERCE",
      "creation_time": "2022-02-03T12:03:34",
      "update_time": "2022-02-03T12:03:37",
      "effective_time": null,
      "confirm_time": null,
      "subacquirer_document": "35524559000103",
      "creation_origin": "NORMAL"
    },
    "transaction_data": {
      "gsurf_usn": "220324000036",
      "card_data": {
        "masked_card": "544828******0007",
        "card_brand": {
          "description": "Mastercard",
          "gsurf_code": 55
        }
      },
      "entry_mode": "virtual",
      "transaction_type": "CREDIT",
      "installment_type": "BY_MERCHANT",
      "provider_data": {
        "response_message": "Success.",
        "response_code": "00",
        "authorization_code": "326260",
        "acquirer_name": "rede",
        "provider_name": "e-sitef",
        "provider_id": "16380c7b-f478-407f-9c2b-a4e0531cef9e",
        "gsurf_correlation_id": "10012203241526016159",
        "acquirer_authorization_usn": "961714228",
        "acquirer_confirmation_usn": null,
        "provider_usn": null,
        "tid": "10012405311627496699"
      },
      "anti_fraud_analysis_data": {
        "status": "IGNORED",
        "code": null,
        "message": null
      }
    }
  }
}

#V1.2

versionstringconst: "1.2"

event_typestring

entitystringconst: "CardPayment"

payloadobject

sale_dataobject

Dados referentes a venda.

amountinteger

Valor da venda.

merchant_correlation_idstring

Identificador da venda na loja.

order_idstring

Número do pedido.

installmentsinteger

Número da parcela.

submerchant_idstring

Identificador da loja.

payment_dataobject

Dados do pagamento.

gtistring

Identificador único da transação de cartão.

statusstring

amount_paidinteger

Valor pago.

channelstring

Canal

creation_timestring

Data de criação do pagamento.

update_timestring

Data da última atualização do pagamento.

effective_timestring | null

Data do pagamento no provedor.

confirm_timestring | null

Data da confirmação do pagamento no gateway.

subacquirer_documentstring

Documento do subadquirente

creation_originstring

Origem da criação da transação.

Enum: "NORMAL", "RECURRENCE"

transaction_dataobject

Dados da transação.

gsurf_usnstring

Número sequencial gsurf.

card_dataobject

Dados do cartão.

masked_cardstring | null

Número do cartão mascarado.

card_brandobject

Dados da bandeira do cartão.

descriptionstring | null

Nome da bandeira do cartão.

gsurf_codeinteger

Código da bandeira na gsurf.

entry_modestring | null

Modo de entrada de pagamento no gateway, virtual/físico.

transaction_typestring

tipo de transação

Enum: "DEBIT", "CREDIT"

installment_typestring

tipo de parcelamento

Enum: "BY_ISSUER", "BY_MERCHANT"

anti_fraud_analysis_dataobject

Dados de resposta referente à análise do anti-fraude.

statusstring

Enum: "IGNORED", "PENDING", "ACCEPT", "REJECT", "IN_REVIEW", "ERROR"

codeinteger

Enum: 100, 480, 481

messagestring | null

Menssagem com informações adicionais sobre o status do antifraude

provider_dataobject

Dados do provedor/adquirente.

response_messagestring | null

Mensagem de resposta da provedor/adquirente.

response_codestring | null

Código da resposta da provedor/adquirente.

authorization_codestring | null

Código de autorização da transação.

acquirer_namestring | null

Nome do adquirente.

provider_namestring | null

Nome do provedor.

provider_idstring | null

Id do resgistro da provedor/adquirente na GSurf.

gsurf_correlation_idstring | null

Identificação da transação de cartão no provedor/adquirente.

acquirer_authorization_usnstring | null

Número sequencial único da autorização da transação no adquirente.

acquirer_confirmation_usnstring | null

Número sequencial único da confirmação da transação no adquirente.

provider_usnstring | null

Número sequencial único da autorização da transação no provedor. Será o mesmo que o acqurier_authorization_usn para casos de comunicação direta com o adquirente.

tidstring | null

Id da transação na adquirente.

error_infoobject

Atributo recebido somente em eventos Emitidos para erro. Contém os dados com os valores de erro

codestring

Código do erro.

messagestring

Mensagem descritiva do erro.

recurrence_dataobject

Atributo recebido somente em eventos Emitidos para transações de recorrencia. Contém os dados da recorrencia.

idstring

Id da recorrencia.

#Exemplo

{
  "version": "1.2",
  "event_type": "AUTHORIZATION",
  "entity": "CardPayment",
  "payload": {
    "sale_data": {
      "amount": 1000,
      "merchant_correlation_id": "026b0627-83dc-42a0-bacc-a06f0da1227",
      "order_id": "20220303timi",
      "installments": 1,
      "submerchant_id": "53391845015"
    },
    "payment_data": {
      "gti": "ba7e5785-bf2d-4cb3-93d4-2aed693599e9",
      "status": "AUTHORIZED",
      "amount_paid": 0,
      "channel": "ECOMMERCE",
      "creation_time": "2022-02-03T12:03:34-03:00",
      "update_time": "2022-02-03T12:03:37-03:00",
      "effective_time": null,
      "confirm_time": null,
      "subacquirer_document": "35524559000103",
      "creation_origin": "NORMAL"
    },
    "transaction_data": {
      "gsurf_usn": "220324000036",
      "card_data": {
        "masked_card": "544828******0007",
        "card_brand": {
          "description": "Mastercard",
          "gsurf_code": 55
        }
      },
      "entry_mode": "virtual",
      "transaction_type": "CREDIT",
      "installment_type": "BY_MERCHANT",
      "provider_data": {
        "response_message": "Success.",
        "response_code": "00",
        "authorization_code": "326260",
        "acquirer_name": "rede",
        "provider_name": "e-sitef",
        "provider_id": "16380c7b-f478-407f-9c2b-a4e0531cef9e",
        "gsurf_correlation_id": "10012203241526016159",
        "acquirer_authorization_usn": "961714228",
        "acquirer_confirmation_usn": null,
        "provider_usn": null,
        "tid": "10012405311627496699"
      },
      "anti_fraud_analysis_data": {
        "status": "IGNORED",
        "code": null,
        "message": null
      }
    }
  }
}

#V1.3

versionstringconst: "1.3"

event_typestring

entitystringconst: "CardPayment"

payloadobject

sale_dataobject

Dados referentes a venda.

amountinteger

Valor da venda.

merchant_correlation_idstring

Identificador da venda na loja.

order_idstring

Número do pedido.

installmentsinteger

Número da parcela.

submerchant_idstring

Identificador da loja.

current_amountinteger

Valor atual da venda.

payment_dataobject

Dados do pagamento.

gtistring

Identificador único da transação de cartão.

statusstring

amount_paidinteger

Valor pago.

channelstring

Canal

creation_timestring

Data de criação do pagamento.

update_timestring

Data da última atualização do pagamento.

effective_timestring | null

Data do pagamento no provedor.

confirm_timestring | null

Data da confirmação do pagamento no gateway.

subacquirer_documentstring

Documento do subadquirente

creation_originstring

Origem da criação da transação.

Enum: "NORMAL", "RECURRENCE"

transaction_dataobject

Dados da transação.

gsurf_usnstring

Número sequencial gsurf.

card_dataobject

Dados do cartão.

masked_cardstring | null

Número do cartão mascarado.

card_brandobject

Dados da bandeira do cartão.

descriptionstring | null

Nome da bandeira do cartão.

gsurf_codeinteger

Código da bandeira na gsurf.

entry_modestring | null

Modo de entrada de pagamento no gateway, virtual/físico.

transaction_typestring

tipo de transação

Enum: "DEBIT", "CREDIT"

installment_typestring

tipo de parcelamento

Enum: "BY_ISSUER", "BY_MERCHANT"

anti_fraud_analysis_dataobject

Dados de resposta referente à análise do anti-fraude.

statusstring

Enum: "IGNORED", "PENDING", "ACCEPT", "REJECT", "IN_REVIEW", "ERROR"

codeinteger

Enum: 100, 480, 481

messagestring | null

Menssagem com informações adicionais sobre o status do antifraude

provider_dataobject

Dados do provedor/adquirente.

response_messagestring | null

Mensagem de resposta da provedor/adquirente.

response_codestring | null

Código da resposta da provedor/adquirente.

authorization_codestring | null

Código de autorização da transação.

acquirer_namestring | null

Nome do adquirente.

provider_namestring | null

Nome do provedor.

provider_idstring | null

Id do resgistro da provedor/adquirente na GSurf.

gsurf_correlation_idstring | null

Identificação da transação de cartão no provedor/adquirente.

acquirer_authorization_usnstring | null

Número sequencial único da autorização da transação no adquirente.

acquirer_confirmation_usnstring | null

Número sequencial único da confirmação da transação no adquirente.

provider_usnstring | null

Número sequencial único da autorização da transação no provedor. Será o mesmo que o acqurier_authorization_usn para casos de comunicação direta com o adquirente.

tidstring | null

Id da transação na adquirente.

authorizer_dataobject

Dados da bandeira.

response_messagestring | null

Mensagem de resposta da bandeira.

response_codestring | null

Código da resposta da bandeira.

error_infoobject

Atributo recebido somente em eventos Emitidos para erro. Contém os dados com os valores de erro

codestring

Código do erro.

messagestring

Mensagem descritiva do erro.

recurrence_dataobject

Atributo recebido somente em eventos Emitidos para transações de recorrencia. Contém os dados da recorrencia.

idstring

Id da recorrencia.

#Exemplo

{
  "version": "1.3",
  "event_type": "AUTHORIZATION",
  "entity": "CardPayment",
  "payload": {
    "sale_data": {
      "amount": 1000,
      "merchant_correlation_id": "026b0627-83dc-42a0-bacc-a06f0da1227",
      "order_id": "20220303timi",
      "installments": 1,
      "submerchant_id": "53391845015",
      "current_amount": 1000
    },
    "payment_data": {
      "gti": "ba7e5785-bf2d-4cb3-93d4-2aed693599e9",
      "status": "AUTHORIZED",
      "amount_paid": 0,
      "channel": "ECOMMERCE",
      "creation_time": "2022-02-03T12:03:34-03:00",
      "update_time": "2022-02-03T12:03:37-03:00",
      "effective_time": null,
      "confirm_time": null,
      "subacquirer_document": "35524559000103",
      "creation_origin": "NORMAL"
    },
    "transaction_data": {
      "gsurf_usn": "220324000036",
      "card_data": {
        "masked_card": "544828******0007",
        "card_brand": {
          "description": "Mastercard",
          "gsurf_code": 55
        }
      },
      "entry_mode": "virtual",
      "transaction_type": "CREDIT",
      "installment_type": "BY_MERCHANT",
      "provider_data": {
        "response_message": "Success.",
        "response_code": "00",
        "authorization_code": "326260",
        "acquirer_name": "rede",
        "provider_name": "e-sitef",
        "provider_id": "16380c7b-f478-407f-9c2b-a4e0531cef9e",
        "gsurf_correlation_id": "10012203241526016159",
        "acquirer_authorization_usn": "961714228",
        "acquirer_confirmation_usn": null,
        "provider_usn": null,
        "tid": "10012405311627496699",
        "authorizer_data": {
          "response_code": "00",
          "response_message": "Success."
        }
      },
      "anti_fraud_analysis_data": {
        "status": "IGNORED",
        "code": null,
        "message": null
      }
    }
  }
}

#V1.4

versionstringconst: "1.4"

event_typestring

entitystringconst: "CardPayment"

payloadobject

sale_dataobject

Dados referentes a venda.

amountinteger

Valor da venda.

merchant_correlation_idstring

Identificador da venda na loja.

order_idstring

Número do pedido.

installmentsinteger

Número da parcela.

submerchant_idstring

Identificador da loja.

current_amountinteger

Valor atual da venda.

payment_dataobject

Dados do pagamento.

gtistring

Identificador único da transação de cartão.

statusstring

amount_paidinteger

Valor pago.

channelstring

Canal

creation_timestring

Data de criação do pagamento.

update_timestring

Data da última atualização do pagamento.

effective_timestring | null

Data do pagamento no provedor.

confirm_timestring | null

Data da confirmação do pagamento no gateway.

capture_timestring | null

Data de captura do pagamento.

authorize_timestring | null

Data de autorização do pagamento.

subacquirer_documentstring

Documento do subadquirente

creation_originstring

Origem da criação da transação.

Enum: "NORMAL", "RECURRENCE"

transaction_dataobject

Dados da transação.

gsurf_usnstring

Número sequencial gsurf.

card_dataobject

Dados do cartão.

masked_cardstring | null

Número do cartão mascarado.

card_brandobject

Dados da bandeira do cartão.

descriptionstring | null

Nome da bandeira do cartão.

gsurf_codeinteger

Código da bandeira na gsurf.

entry_modestring | null

Modo de entrada de pagamento no gateway, virtual/físico.

transaction_typestring

tipo de transação

Enum: "DEBIT", "CREDIT"

installment_typestring

tipo de parcelamento

Enum: "BY_ISSUER", "BY_MERCHANT"

anti_fraud_analysis_dataobject

Dados de resposta referente à análise do anti-fraude.

statusstring

Enum: "IGNORED", "PENDING", "ACCEPT", "REJECT", "IN_REVIEW", "ERROR"

codeinteger

Enum: 100, 480, 481

messagestring | null

Mensagem com informações adicionais sobre o status do antifraude

provider_dataobject

Dados do provedor de antifraude.

provider_namestring | null

Nome do provedor de antifraude.

provider_idstring | null

ID do registro do provder na GSurf.

authorization_responseobject | null

Estes campos são mapeados com base especificamente na resposta de cada provedor na autorização do antifraude (são dinâmicos e serão diferentes pra cada provedor - por exemplo, na cybersource ou clearsale).

review_responseobject | null

Estes campos são mapeados com base especificamente na resposta de cada provedor da revisão do antifraude (são dinâmicos e serão diferentes pra cada provedor - por exemplo, na cybersource ou clearsale).

provider_dataobject

Dados do provedor/adquirente.

response_messagestring | null

Mensagem de resposta da provedor/adquirente.

response_codestring | null

Código da resposta da provedor/adquirente.

acquirer_response_messagestring | null

Mensagem de resposta do adquirente.

acquirer_response_codestring | null

Código da resposta do adquirente.

authorization_codestring | null

Código de autorização da transação.

acquirer_namestring | null

Nome do adquirente.

provider_namestring | null

Nome do provedor.

provider_idstring | null

Id do resgistro da provedor/adquirente na GSurf.

gsurf_correlation_idstring | null

Identificação da transação de cartão no provedor/adquirente.

acquirer_authorization_usnstring | null

Número sequencial único da autorização da transação no adquirente.

acquirer_confirmation_usnstring | integer | null

Número sequencial único da confirmação da transação no adquirente.

provider_usnstring | null

Número sequencial único da autorização da transação no provedor. Será o mesmo que o acqurier_authorization_usn para casos de comunicação direta com o adquirente.

tidstring | null

Id da transação na adquirente.

authorizer_dataobject

Dados da bandeira.

response_messagestring | null

Mensagem de resposta da bandeira.

response_codestring | null

Código da resposta da bandeira.

error_infoobject

Atributo recebido somente em eventos Emitidos para erro. Contém os dados com os valores de erro

codestring

Código do erro.

messagestring

Mensagem descritiva do erro.

recurrence_dataobject

Atributo recebido somente em eventos Emitidos para transações de recorrencia. Contém os dados da recorrencia.

idstring

Id da recorrencia.

#Exemplo

{
    "version": "1.4",
    "entity": "CardPayment",
    "event_type": "CONFIRMATION",
    "payload": {
        "payment_data": {
            "gti": "549cfa22-d543-4cb5-92fc-daa69df9ec67",
            "status": "CONFIRMED",
            "amount_paid": 290,
            "channel": "ECOMMERCE",
            "creation_time": "2025-03-11T11:10:50-03:00",
            "update_time": "2025-03-11T11:14:26-03:00",
            "effective_time": "2025-03-11T11:10:57-03:00",
            "confirm_time": "2025-03-11T11:14:26-03:00",
            "subacquirer_document": "05643319000159",
            "creation_origin": "NORMAL",
            "capture_time": null,
            "authorize_time": "2025-03-11T14:10:59"
        },
        "sale_data": {
            "amount": 290,
            "merchant_correlation_id": "026b0627-83dc-42a0-bacc-a06f0da1227f",
            "order_id": "12345678",
            "installments": 1,
            "submerchant_id": "34889236000142",
            "current_amount": 290
        },
        "transaction_data": {
            "gsurf_usn": "250311000004",
            "card_data": {
                "masked_card": "450799******4905",
                "card_brand": {
                    "description": "Visa",
                    "gsurf_code": 85
                }
            },
            "entry_mode": "virtual",
            "transaction_type": "CREDIT",
            "installment_type": "BY_MERCHANT",
            "provider_data": {
                "response_message": "Success",
                "response_code": "00",
                "acquirer_response_message": null,
                "acquirer_response_code": null,
                "authorization_code": "111059",
                "acquirer_name": "Prisma",
                "provider_name": "prisma",
                "provider_id": "ca0aa5b4-db0b-4b1d-be81-7f7f1e32032c",
                "gsurf_correlation_id": "14457755",
                "acquirer_authorization_usn": "9947",
                "acquirer_confirmation_usn": 1244406,
                "provider_usn": "9947",
                "tid": null,
                "authorizer_data": {
                    "response_code": null,
                    "response_message": null
                }
            },
            "anti_fraud_analysis_data": {
                "status": "ACCEPT",
                "code": 100,
                "message": "Nenhuma suspeita encontrada. | Nenhum motivo para rejeitar. | Ferramentas de terceiros: endereço correspondente de cobrança e de envio. | Ferramentas de terceiros: endereço de cobrança correspondente. | Ferramentas de terceiros: endereço de envio correspondente. | Ferramentas de terceiros: endereço correspondente completo.",
                "provider_data": {
                    "provider_id": "7316ae1b-c9a0-4060-896f-383a7dd33347",
                    "provider_name": "cyber",
                    "authorization_response": {
                        "riskInformation": {
                            "score": {
                                "result": "97",
                                "factorCodes": [
                                    "E",
                                    "H",
                                    "P"
                                ],
                                "modelUsed": "default_lac"
                            },
                            "profile": {
                                "earlyDecision": "ACCEPT",
                                "destinationQueue": "Revisão - GSurf",
                                "name": "GSurf - Primeiro pedido",
                                "selectorRule": "GSurf - Primeiro pedido"
                            }
                        },
                        "status": "PENDING_REVIEW"
                    },
                    "review_response": {
                        "conversionDetails": [
                            {
                                "reviewerComments": "Nenhuma suspeita encontrada. | Nenhum motivo para rejeitar. | Ferramentas de terceiros: endereço correspondente de cobrança e de envio. | Ferramentas de terceiros: endereço de cobrança correspondente. | Ferramentas de terceiros: endereço de envio correspondente. | Ferramentas de terceiros: endereço correspondente completo.",
                                "reviewer": "ivan.ribeiro",
                                "notes": [
                                    {
                                        "time": "2025-03-11T14:13:56.000Z",
                                        "comments": "Propriedade obtida.",
                                        "requestId": "7417022604436315904807",
                                        "addedBy": "ivan.ribeiro"
                                    }
                                ],
                                "newDecision": "ACCEPT",
                                "queue": "Example",
                                "conversionTime": "2025-03-11T14:13:56.000Z"
                            }
                        ]
                    }
                }
            }
        }
    }
}

Hooks de Pagamento de Cartão

#Introdução

#Tipos de eventos

#Payload

#Changelog

#V1.0

#Exemplo

#V1.1

#Exemplo

#V1.2

#Exemplo

#V1.3

#Exemplo

#V1.4

#Exemplo