POST Integration/{integrationId}

A rota /Integration/integrationId permite integrar informações específicas de uma transação identificada pelo integrationId. Ela recebe dados detalhados sobre a transação, como valores, dispositivos, informações de cobrança e envio, além de itens e pagamentos. Após o processamento, a rota retorna uma análise com resultados, incluindo decisões, verificações biométricas e insights. É necessário autenticar-se com um token de segurança para utilizá-la.

Serviço Online: Link

Schemas

Request

Descrição: Representa a requisição para integração.

Campos	Descrição	Tipo	Obrigatório
transaction	Informações da transação.	Transaction	Sim
transactionValue	Informações do dispositivo.	Transaction Value	Não
device	Informações de envio.	Device	Não
billing	Informações de cobrança.	Billing	Sim
shipping	Informações de envio.	Shipping	Não
items	Lista de itens da transação.	Item Array	Não
payments	Lista de métodos de pagamento.	Payment Array	Não

Transaction

Descrição: Representa os dados da transação.

Campos	Descrição	Tipo	Obrigatório
code	Código único da transação	String	Sim
date	Data da transação	DateTime	Sim
email	E-mail associado à transação	String	Sim
status	Status da transação	Integer	Não
ipAddress	Endereço IP do cliente	String	Sim
origin	Origem da transação	String	Não
observation	Observações adicionais	String	Sim

Transaction Value

Descrição: Representa o valor total da transação.

Campos	Descrição	Tipo	Obrigatório
totalValue	Valor total da transação	Float	Sim

Device

Descrição: Representa informações do dispositivo utilizado na transação.

Campos	Descrição	Tipo	Obrigatório
fingerprint	Identificador único do dispositivo	Fingerprint	Sim

Fingerprint

Descrição: Representa as informações de identificação do dispositivo utilizado na transação.

Campos	Descrição	Tipo	Obrigatório
sessionId	Identificador único da sessão do dispositivo	Guid	Sim

Billing

Descrição: Representa as informações de cobrança.

Campos	Descrição	Tipo	Obrigatório
type	Tipo de pessoa	Integer	Não
name	Nome do cliente	String	Sim
email	E-mail do cliente	String	Não
gender	Gênero do cliente	String	Não
birthdate	Data de nascimento	DateTime	Sim
documents	Documentos associados ao cliente	DocumentArray	Sim
address	Endereço de cobrança	Address	Sim
phones	Telefones associados ao cliente	PhoneArray	Sim

Shipping

Descrição: Representa as informações de envio.

Campos	Descrição	Tipo	Obrigatório
type	Tipo de pessoa	Integer	Não
price	Preço do envio	Float	Sim
name	Nome do destinatário	String	Sim
email	E-mail do destinatário	String	Não
gender	Gênero do destinatário	String	Não
birthdate	Data de nascimento do destinatário	DateTime	Sim
clientId	Identificador do cliente	String	Não
deliveryType	Tipo de entrega	Integer	Sim
deliveryTime	Tempo estimado de entrega	String	Não
documents	Documentos associados ao destinatário	Document Array	Não
address	Endereço de envio	Address	Não
phones	Telefones associados	Phone Array	Não

Item

Descrição: Representa um item da transação.

Campos	Descrição	Tipo	Obrigatório
code	Código do item	String	Não
name	Nome do item	String	Não
description	Descrição do item	String	Sim
categoryId	ID da categoria do item	Integer	Não
categoryName	Nome da categoria do item	String	Não
barCode	Código de barras do item	String	Não
value	Valor do item	Float	Sim
quantity	Quantidade do item	Integer	Sim
isGift	Indica se o item é um presente	Boolean	Não
sellerName	Nome do vendedor	String	Não
sellerSegment	Segmento do vendedor	String	Não
isMarketPlace	Indica se é um marketplace	String	Não
shippingCompany	Empresa de envio	String	Não
sellerDocument	Documento do vendedor	Document	Não

Payment

Descrição: Representa um método de pagamento.

Campos	Descrição	Tipo	Obrigatório
type	Tipo de pagamento	Integer	Sim
value	Valor do pagamento	Float	Sim
currency	Moeda utilizada	Integer	Não
sequential	Número sequencial do pagamento	Integer	Não
paymentDate	Data do pagamento	DateTime	Não
installments	Número de parcelas	Integer	Não
payableType	Categoria do pagamento dentro do segmento	String	Não
interestRate	Taxa de juros aplicada ao pagamento	Float	Não
interestValue	Valor dos juros aplicados	Float	Não
visaCheckoutUserId	Identificador do usuário no Visa Checkout	String	Não
digitalWalletCode	Código da carteira digital utilizada	String	Não
voucherOrderOrigin	Origem do pedido do voucher	String	Não
subAcquirer	Subadquirente responsável pelo pagamento	String	Não
bankAuthentication	Informações de autenticação bancária	String	Não
card	Informações do cartão de crédito	Card	Não

Card

Descrição: Representa as informações de um cartão de crédito.

Campos	Descrição	Tipo	Obrigatório
ownerName	Nome do titular do cartão	String	Sim
number	Número do cartão	String	Sim
hash	Hash do número do cartão	String	Não
bin	BIN (Bank Identification Number) do cartão	String	Sim
end	Últimos dígitos do cartão	String	Sim
type	Tipo do cartão	Integer	Não
expirationDate	Data de expiração do cartão	String	Não
document	Documento associado ao cartão	Document	Não

Document

Descrição: Representa um documento associado a uma entidade.

Campos	Descrição	Tipo	Obrigatório
type	Tipo do documento	Integer	Sim
number	Número do documento	String	Sim
documentTypeCustomer	Tipo de cliente associado ao documento	String	Não
authority	Autoridade emissora do documento	String	Não
authorityState	Estado da autoridade emissora	String	Não
issueDate	Data de emissão do documento	String	Não

Address

Descrição: Representa um endereço.

Campos	Descrição	Tipo	Obrigatório
type	Tipo do endereço	String	Sim
addressId	Identificador do endereço	String	Não
street	Nome da rua	String	Sim
number	Número do endereço	String	Sim
district	Bairro	String	Não
city	Cidade	String	Sim
state	Estado	String	Sim
zipcode	Código postal	String	Sim
country	País	String	Sim
additionalInformation	Informações adicionais	String	Não
reference	Referência do endereço	String	Não
latitude	Latitude do endereço	String	Não
longitude	Longitude do endereço	String	Não

Phone

Descrição: Representa as informações de um telefone associado a uma entidade.

Campos	Descrição	Tipo	Obrigatório
type	Tipo do telefone	Integer	Sim
countryCode	Código do país do telefone	String	Não
areaCode	Código de área do telefone	String	Sim
number	Número do telefone	String	Sim
extension	Ramal associado ao telefone	String	Não

Response

Descrição: Representa a resposta de execução da integração.

Campos	Descrição	Tipo	Obrigatório
analysisId	ID da análise	Guid	Sim
transactionId	ID da transação	String	Sim
decision	Resultado da decisão	Decision Result	Não
mfa	Resultado de autenticação multifator	Mfa Result	Não
biolink	Resultado do Biolink	Biolink Result	Não
insights	Resultados de insights	Insights Result	Não

Decision Result

Descrição: Representa o resultado de uma decisão.

Campos	Descrição	Tipo	Obrigatório
status	Status da decisão	String	Sim
score	Pontuação associada à decisão	Float	Não
result	Resultado da decisão	String	Não
metadata	Metadados adicionais	Object	Não

Mfa Result

Descrição: Representa o resultado de uma autenticação multifator (MFA).

Campos	Descrição	Tipo	Obrigatório
status	Status da autenticação	String	Sim
option	Opção utilizada para autenticação	String	Não
message	Mensagem associada ao resultado	String	Não
repliedAt	Data e hora da resposta	DateTime	Não

Biolink Result

Descrição: Representa o resultado de uma análise biométrica.Campos:status (string, opcional): Status da análise.

Campos	Descrição	Tipo	Obrigatório
status	Status da análise	String	Sim
document	Informações do documento analisado	Biolink Document	Não
selfie	Informações da selfie analisada	Biolink Selfie	Não
biometrics	Informações biométricas	Biolink Biometrics	Não

Biolink Document

Descrição: Representa as informações de um documento analisado no contexto de biometria.

Campos	Descrição	Tipo	Obrigatório
documentFrontUrl	URL da imagem da frente do documento	String	Sim
documentBackUrl	URL da imagem do verso do documento	String	Sim
expirationDateUtc	Data de expiração do documento em formato UTC	DateTime	Sim

Biolink Selfie

Descrição: Representa as informações de uma selfie analisada no contexto de biometria.

Campos	Descrição	Tipo	Obrigatório
selfieUrl	URL da imagem da selfie	String	Sim
expirationDateUtc	Data de expiração da selfie em formato UTC	DateTime	Sim

Biolink Biometrics

Descrição: Representa as informações biométricas analisadas.

Campos	Descrição	Tipo	Obrigatório
score	Pontuação da análise biométrica	Double	Não
status	Status da análise biométrica	String	Sim
createdAt	Data de criação da análise	DateTime	Sim
identifierDate	Data de identificação	DateTime	Sim
message	Mensagem associada à análise biométrica	String	Não

Insights Result

Descrição: Representa os insights gerados pela análise.

Campos	Descrição	Tipo	Obrigatório
status	Status dos insights	String	Sim
result	Lista de insights gerados	Insight Array	Não

Insight

Descrição: Representa um insight gerado pela análise.

Campos	Descrição	Tipo	Obrigatório
code	Código do insight	String	Sim
description	Descrição do insight	String	Sim
type	Tipo do insight	String	Sim
category	Categoria do insight	String	Sim
relevance	Relevância do insight	String	Sim
relatedTo	Entidade ou elemento relacionado ao insight	String[]	Sim

Response Error

Descrição: Representa os detalhes de um problema retornado pela API em caso de erro.

Campos	Descrição	Tipo	Obrigatório
type	URI que identifica o tipo de problema específico. Pode ser usado para categorizar o erro.	String	Não
title	Título descritivo do problema	String	Sim
status	Código de status HTTP associado ao problema	Integer	Sim
errors	Erros de validação	Object	Sim
instance	URI que identifica a instância específica do problema	String	Não